ISteamVideo 接口（Steamworks 文献库）

Steamworks 文献库

ISteamVideo 接口

Steamworks 文献库 > Steamworks API 索引 > ISteamVideo 接口

提供与 Steam 视频和直播平台交互的函数。

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

成员函数

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

GetOPFSettings

void GetOPFSettings( AppId_t unVideoAppID );

名称	类型	描述
unVideoAppID	AppId_t	要获取 OPF 详情的视频 AppID。

获取 360 视频播放的 OPF 详情

要获取 360 OPF（开放投影格式）数据以播放 360 视频，首先调用此函数，然后回调将指示请求是否成功。如果成功，则可以通过调用 GetOPFStringForApp 获取实际的 OPF JSON 数据。

返回：void
触发 GetOPFSettingsResult_t 回调。

GetOPFStringForApp

bool GetOPFStringForApp( AppId_t unVideoAppID, char *pchBuffer, int32 *pnBufferSize );

名称	类型	描述
unVideoAppID	AppId_t	要获取 OPF 字符串的视频 AppID。
pchBuffer	char *	通过将 OPF 字符串写入此缓冲区来返回它。
pnBufferSize	int32 *	这应设置为 `pchBuffer` 的大小，并返回写入 `pchBuffer` 的字节数。

获取指定视频应用 ID 的 OPF 字符串。

触发 GetOPFSettingsResult_t 回调且 EResult 指示成功时，调用此函数将返回 JSON 格式的实际 OPF 数据。 OPF 字符串的大小不固定，但目前 48,000 字节应足以容纳完整字符串。如果不足，pnBufferSize 将被设置为所需的大小。在这种情况下，请使用正确的缓冲区大小再次调用该函数。

注意：成功调用 GetOPFStringForApp() 返回的数据只能检索一次。如果需要多次获取数据，则每次都需要调用 GetOPFSettings。

返回： bool
如果先前调用 GetOPFSettings 时获取了 OPF 详细信息，为 true，否则为 false。

返回 pchBuffer中的详细信息。

有关 OPF 格式的描述及响应示例，请查看 Pixvana OPF 网页。

GetVideoURL

void GetVideoURL( AppId_t unVideoAppID );

名称	类型	描述
unVideoAppID	AppId_t	要接收视频流的视频应用 ID。

异步获取 URL，用于流式传输与指定视频应用 ID 关联的视频。

返回：void
触发 GetVideoURLResult_t 回调。

另见： 维基百科上的 DASH 词条。

IsBroadcasting

bool IsBroadcasting( int *pnNumViewers );

名称	类型	描述
pnNumViewers	int *	返回当前正在观看直播的观众数量。

检查用户是否正在进行直播，并获取当前观众数量。

返回： bool
如果用户正在上传直播则为true，否则为 false。

如果用户当前正在直播，则通过 pnNumViewers 返回观众数量。

Callbacks

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

BroadcastUploadStart_t

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

此回调无字段。

BroadcastUploadStop_t

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

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

GetOPFSettingsResult_t

当检索到用于 360 视频播放的 OPF 详细信息时触发。
收到此回调后，您可以使用 GetOPFStringForApp 来访问 OPF 详细信息。

名称	类型	描述
m_eResult	EResult	操作结果。以下为可能值： k_EResultOK - 成功 k_EResultInvalidParam - 此应用程序并非视频，无法进行流式传输。 k_EResultFileNotFound - 该视频尚未进行处理，无法流式传输。 k_EResultAccessDenied - 此视频无法访问。请确保您登录的帐户拥有此视频。 k_EResultNoConnection k_EResultServiceUnavailable - 视频服务器不可用。 k_EResultTimeout - 此视频目前无法流式传输。 k_EResultBlocked - 抱歉，此视频目前尚不可观看。
m_unVideoAppID	AppId_t	我们获取详细信息的视频的应用 ID。

关联函数： GetOPFSettings

GetVideoURLResult_t

提供 GetVideoURL 调用的结果。

名称	类型	描述
m_eResult	EResult	操作结果。如果调用成功，返回 k_EResultOK。如果提供的应用 ID 不是视频应用 ID，或者用户未拥有其许可，则返回 k_EResultInvalidParam。
m_unVideoAppID	AppId_t	最初调用 GetVideoURL 时提供的 App ID。
m_rgchURL	char［256］	如果调用成功，这将包含 MPEG-DASH 标准架构格式的 xml 文档 URL。该文档可以用于流式传输相关内容。

关联函数： GetVideoURL

常量

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

名称	类型	值	描述
STEAMVIDEO_INTERFACE_VERSION	const char *	"STEAMVIDEO_INTERFACE_V002"