Provides functions to interface with the Steam video and broadcasting platforms.
See Streaming Video
for more information.
Member functions for
are called through the global accessor function
void GetOPFSettings( AppId_t unVideoAppID );
|unVideoAppID||AppId_t||The video app ID to get the OPF details of.|
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
Triggers a GetOPFSettingsResult_t
bool GetOPFStringForApp( AppId_t unVideoAppID, char *pchBuffer, int32 *pnBufferSize );
|unVideoAppID||AppId_t||The video app ID to get the OPF string for.|
|pchBuffer||char *||Returns the OPF string by writing it to this buffer.|
|pnBufferSize||int32 *||This should be set to the size of |
pchBuffer, and returns the number of bytes written to
Gets the OPF string for the specified video App ID.
Once the callback for GetOPFSettingsResult_t
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. If it is not,
will be set to the size required. In that case, make a second call with the correct buffer size.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.Returns:
if we have the OPF details from a previous call to GetOPFSettings
, otherwise false
Returns the details in
For a description of the OPF format and an example response, please see the Pixvana OPF web page
void GetVideoURL( AppId_t unVideoAppID );
|unVideoAppID||AppId_t||The video app ID to receive the video stream for.|
Asynchronously gets the URL suitable for streaming the video associated with the specified video app ID.Returns:
Triggers a GetVideoURLResult_t
callback.See Also: DASH on Wikipedia
bool IsBroadcasting( int *pnNumViewers );
|pnNumViewers||int *||Returns the number of viewers currently watching the live broadcast.|
Checks if the user is currently live broadcasting and gets the number of users.Returns:
if user is uploading a live broadcast, otherwise false
Returns the number of viewers via
if the user is currently broadcasting.
These are callbacks which can be fired by calling SteamAPI_RunCallbacks
. Many of these will be fired directly in response to the member functions of
Automatically called whenever the user starts broadcasting.
This callback has no fields.
Automatically called whenever the user stops broadcasting.
Triggered when the OPF Details for 360 video playback are retrieved.
After receiving this you can use GetOPFStringForApp
to access the OPF details.Associated Functions: GetOPFSettings
Provides the result of a call to GetVideoURL
Associated Functions: GetVideoURL
|m_eResult||EResult||The result of the operation.|
|m_unVideoAppID||AppId_t||The App ID provided in the original call to GetVideoURL.|
|m_rgchURL||char［256］||If the call was successful this contains the URL to the MPEG-DASH Standard schema formatted xml document which can be used to stream the content.|
These are constants which are defined for use with ISteamVideo.
|STEAMVIDEO_INTERFACE_VERSION||const char *||"STEAMVIDEO_INTERFACE_V002"|