Video

Provides functions to interface with the Steam video and broadcasting platforms. See Steam Video for more information.

Only available in the main GodotSteam branches

Functions

getOPFSettings

getOPFSettings( uint32_t app_id )

Get the OPF details for 360 video playback.

To retrieve the 360 OPF (open projection format) data to playback a 360 video, start by making a call to this, then the callback will indicate whether the request was successful. If it was successful, the actual OPF JSON data can be retrieved with a call to getOPFStringForApp.

Returns: void

Notes: Triggers a get_opf_settings_result callback.

getOPFStringForApp

getOPFStringForApp( uint32_t app_id )

Gets the OPF string for the specified video app ID.

Once the callback for get_opf_settings_result has been raised and the EResult indicates success, then calling this will return back the actual OPF data in a JSON format. The size of the OPF string varies, but at this time 48,000 bytes should be sufficient to contain the full string.

Returns: string

Note: The data returned in a successful call to getOPFStringForApp can only be retrieved once. If you need to retrieve it multiple times, a call to getOPFSettings will need to be made each time.

getVideoURL

getVideoURL( uint32_t app_id )

Asynchronously gets the URL suitable for streaming the video associated with the specified video app ID.

Returns: void

Notes: Triggers a get_video_result callback.

isBroadcasting

isBroadcasting()

Checks if the user is currently live broadcasting and gets the number of users.

Returns: dictionary

Contains the following keys:

broadcasting (bool)
viewers (int)

Signals

These callbacks require you to run Steam.run_callbacks() in your _process() function to receive them.

get_opf_settings_result

broadcast_upload_start

Automatically called whenever the user starts broadcasting.

Returns: is_rtmp (bool)

broadcast_upload_stop

Automatically called whenever the user stops broadcasting.

Returns: result (int / BroadcastUploadResult)

get_opf_settings_result

Triggered when the OPF Details for 360 video playback are retrieved. After receiving this you can use getOPFStringForApp to access the OPF details.

Returns:

result (int)
app_id (uint32)

get_video_result

Provides the result of a call to getVideoURL.

Returns:

result (int)
app_id (uint32)
url (string)