Steamworks 文献库
ISteamVideo 接口
提供与 Steam 视频和直播平台交互的函数。

参见features/streaming_video,了解更多信息。

成员函数

ISteamVideo 的成员函数通过全局访问器函数 ISteamVideo 调用。

GetOPFSettings

void GetOPFSettings( AppId_t unVideoAppID );
名称类型描述
unVideoAppIDAppId_t要获得其 OPF 详情的视频 app ID。

为播放 360 全景视频获取 OPF 详情

要获取 360 OPF(开放式投影格式)数据以播放 360 全景视频,应先调用此函数,然后回调将显示请求是否成功。 若成功,具体的 OPF JSON 数据可以通过调用 GetOPFStringForApp 获取。

返回: void
触发一个 GetOPFSettingsResult_t 回调。

GetOPFStringForApp

bool GetOPFStringForApp( AppId_t unVideoAppID, char *pchBuffer, int32 *pnBufferSize );
名称类型描述
unVideoAppIDAppId_t要获得其 OPF 字符串的视频的 App ID。
pchBufferchar *将 OPF 字符串写入此缓冲区以返回。
pnBufferSizeint32 *应当设置为 pchBuffer 的大小,并返回写入 pchBuffer 的字节数。

为指定视频 App ID 获得 OPF 字符串。

一旦 GetOPFSettingsResult_t 被回调,且 EResult 显示成功,那么调用此函数将返回以 JSON 格式返回具体的 ODF 数据。 OPF 字符串的大小各异,但目前 48,000 字节应足以包含整个字符串。 若不能, pchBuffer 将被设置为所需的大小。 在这种情况下,用正确的缓冲区大小进行第二次调用。

注意: 成功调用 GetOPFStringForApp() 所返回的数据只能获取一次。 如果您需要获取多次,则需要每次都调用一次 GetOPFSettings

返回: bool
true, 表示我们有前面调用 GetOPFSettings 所获得的 OPF 详情;否则返回 false

返回 pchBuffer 的细节。

请参见 Pixvana OPF 网页,了解 OPF 格式的描述与相应示例。

GetVideoURL

void GetVideoURL( AppId_t unVideoAppID );
名称类型描述
unVideoAppIDAppId_t要获取其视频流的视频 app ID。

异步获取 URL,该 URL 适合流式传输与指定视频 app ID 关联的视频。

返回: void
触发一个 GetVideoURLResult_t 回调。


另见: https://zh.wikipedia.org/wiki/%E5%9F%BA%E4%BA%8EHTTP%E7%9A%84%E5%8A%A8%E6%80%81%E8%87%AA%E9%80%82%E5%BA%94%E6%B5%81维基百科页面

IsBroadcasting

bool IsBroadcasting( int *pnNumViewers );
名称类型描述
pnNumViewersint *返回当前观看直播的观众人数。

检查是否用户当前正在进行实况直播,并获得用户人数。

返回: bool
true, 表示用户正在上传直播;否则返回 false

如果用户正在直播,通过 pnNumViewers 返回观众人数。

回调

以下是可以通过调用 SteamAPI_RunCallbacks 触发的回调。 其中许多将响应 ISteamVideo 的成员函数直接触发。

BroadcastUploadStart_t

在用户开始直播时自动调用。

此回调无字段。

BroadcastUploadStop_t

在用户停止直播时自动调用。

名称类型描述
m_eResultEBroadcastUploadResult直播停止的原因。

GetOPFSettingsResult_t

在获取 360 全景视频播放的 OPF 详情时触发。
在获得此回调后,您可以使用 GetOPFStringForApp,访问 OPF 详情。

名称类型描述
m_eResultEResult操作的结果。
可能的值:
m_unVideoAppIDAppId_t我们获得详情的视频的 app ID。

关联函数: GetOPFSettings

GetVideoURLResult_t

提供 GetVideoURL 的调用结果。

名称类型描述
m_eResultEResult操作结果。
m_unVideoAppIDAppId_t在最初调用 GetVideoURL 时提供的 app ID。
m_rgchURLchar[256]如果调用成功,则包含 MPEG-DASH 标准的 xml schema 文档的 URL,可以用于流式传输内容。

关联函数: GetVideoURL

常量

以下是定义来与 ISteamVideo 一起使用的常量。

名称类型描述
STEAMVIDEO_INTERFACE_VERSIONconst char *"STEAMVIDEO_INTERFACE_V002"