RTMP Streaming & Browser Recording

curl \
    --location \
    --request POST 'https://prod-in2.100ms.live/api/v2/beam' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <management_token>' \
    --data-raw '{
        "operation": "start",
        "room_id": <rooom_id>,
        "meeting_url": <meeting_url>,
        "rtmp_urls": [<rtmp_url_1>, <rtmp_url_2>],
        "record": true,
        "resolution" : {"width": 1280, "height": 720}
    }'

Headers

Body Parameters

meeting_url

This is a URL which lands into the meeting directly. If you are using 100ms apps then this will be like - https://<domain>.app.100ms.live/preview/<room_id>/<role>?skip_preview=true.

Please check the following to understand how these params are useful while starting RTMP streaming or browser recording with 100ms app links:

• skip_preview=true: skips the preview page and directly joins the meeting with header and controls disabled.
• skip_preview_headful=true: skips the preview page and directly joins the meeting with header and controls enabled.
• auth_token=token1234: Use this to pass the auth token to authenticate the room join request for the beam bot to join the web app to start recording.
• ui_mode=activespeaker: opens active speaker mode by default for recording. In active speaker mode, the current speaker will show up in the center, and rest of the peers will show up in the sidebar.
• name=johndoe: Use this to add a name for the respective peer.

Example - https://myname.app.100ms.live/preview/61101349d0f56e684b608c08/__internal_recorder?skip_preview=true&auth_token=token1234&ui_mode=activespeaker

Note: Ensure meeting_url belongs to the room_id so that beam is aware of the meeting session.

rtmp_urls

This URL is the combination of RTMP server URL and stream key. You can add up to 3 RTMP URLs (as array of strings) for this argument.

• Format: rtmp://server.com/app/STREAM_KEY
• Example: rtmp://a.rtmp.youtube.com/live2/k0jv-329m-1y7f-ktth-ck48
  • "rtmp://a.rtmp.youtube.com/live2/" - RTMP stream URL.
  • "k0jv-329m-1y7f-ktth-ck48" - RTMP stream key.

• Please refer to the platform specific documentation for details on how to obtain the stream URL and stream key. Here are some examples:
  • YouTube
  • Facebook
  • Instagram
  • Twitch
  • LinkedIn

resolution

Minimum Resolution supported from 500x480 (in landscape mode) and 500x500 (in portrait mode) Maximum Resolution supported up to 1920x1080 (in landscape mode) and 1080x1920 (in portrait mode)

curl \
    --location \
    --request POST 'https://prod-in2.100ms.live/api/v2/beam' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <management_token>' \
    --data-raw '{
        "operation": "stop",
        "room_id": <rooom_id>
    }'

Headers

Body Paramters