ISteamVideoインターフェイス (Steamworks ドキュメント)

Steamworks ドキュメンテーション

ISteamVideoインターフェイス

Steamworks ドキュメント > Steamworks API リファレンス > ISteamVideoインターフェイス

Steam動画やブロードキャストプラットフォームとインターフェイスする機能を提供します。

詳細はfeatures/streaming_videoを参照してください。

メンバー関数

ISteamVideoのメンバー関数は、グローバルのアクセサ関数SteamVideo()経由で呼び出されます。

GetOPFSettings

void GetOPFSettings( AppId_t unVideoAppID );

名前	Type	説明
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 );

名前	Type	説明
unVideoAppID	AppId_t	OPF文字列を取得する動画のAppID。
pchBuffer	char *	このバッファに書き込むことで、OPF文字列を返します。
pnBufferSize	int32 *	これは`pchBuffer`のサイズに設定されるべきで、`pchBuffer`に書き込まれたバイト数を返します。

指定の動画AppIDのOPF文字列を取得します。

GetOPFSettingsResult_tのコールバックが発生し、EResultが成功を示すと、これを呼び出すことで実際のOPFデータがJSON形式で返されます。 OPF文字列のサイズは様々ですが、現時点では完全な文字列を含めるためには48,000バイトで十分です。十分ではない場合、pnBufferSizeに必要なサイズが設定されます。その場合には、正しいバッファサイズで二回目の呼び出しを行います。

注意： GetOPFStringForApp()への正常な呼び出しで返されたデータは、一度しか取得できません。複数回取得する必要がある場合は、その度にGetOPFSettingsを呼び出してください。

戻り値： bool
true となるのは以前のGetOPFSettingsへの呼び出しからのOPF詳細がある場合、それ以外は falseです。

pchBufferに詳細を返します。

OPF形式と応答例についてはPixvana OPFウェブページを参照してください。

GetVideoURL

void GetVideoURL( AppId_t unVideoAppID );

名前	型	説明
unVideoAppID	AppId_t	動画ストリームを受け取る動画のAppID。

指定の動画のAppIDに関連する動画のストリーミングに適したURLを、非同期に取得します。

戻り値： void
GetVideoURLResult_tコールバックをトリガーします。

こちらも参照してください： DASH on Wikipedia

IsBroadcasting

bool IsBroadcasting( int *pnNumViewers );

名前	型	説明
pnNumViewers	int *	ライブブロードキャストの現在の視聴者数を返します。

ユーザーが現在ライブ放送しているかどうかを確認し、ユーザー数を取得します。

戻り値： bool
true となるのはユーザーがライブブロードキャストをアップロードしている場合で、それ以外はfalseです。

ユーザーが現在ブロードキャスト中の場合は、pnNumViewers経由で視聴者数を返します。

コールバック

以下はSteamAPI_RunCallbacksを呼び出すことによって実行されるコールバックです。これらの多くはISteamVideoのメンバー関数への応答として直接実行されます。

BroadcastUploadStart_t

ユーザーがブロードキャストを開始すると自動で呼び出されます。

このコールバックにはフィールドはありません。

BroadcastUploadStop_t

ユーザーがブロードキャストを停止すると自動で呼び出されます。

名前	型	説明
m_eResult	EBroadcastUploadResult	ブロードキャストが停止した理由。

GetOPFSettingsResult_t

360動画再生が取得された時にOPF詳細をトリガーします。
これを受け取った後は、OPF詳細へのアクセスにはGetOPFStringForAppを使用できます。

名前	型	説明
m_eResult	EResult	呼び出しの結果。可能な値： k_EResultOK - 成功 k_EResultInvalidParam - このアプリケーションは動画ではなく、ストリームできません。 k_EResultFileNotFound - この動画はストリーミング用に処理されていません。 k_EResultAccessDenied - この動画にアクセスできませんでした。ログイン中のアカウントがこの動画を所有していることを確認してください。 k_EResultNoConnection k_EResultServiceUnavailable - 動画サービスが利用できません。 k_EResultTimeout - この動画は現在ストリームに利用できません。 k_EResultBlocked - この動画はまだ視聴できません。
m_unVideoAppID	AppId_t	詳細を取得する動画のAppID。

関連する関数: GetOPFSettings

GetVideoURLResult_t

GetVideoURL呼び出しの結果を提供します。

名前	型	説明
m_eResult	EResult	呼び出しの結果。呼び出しが成功した場合、k_EResultOK。提供されたAppIDが有効ではないか、ユーザーがライセンスを所有していない場合はk_EResultInvalidParam。
m_unVideoAppID	AppId_t	GetVideoURLへのオリジナルの呼び出しで提供されたアプリID。
m_rgchURL	char［256］	呼び出しが成功した場合、これにはコンテンツのストリーミングに使用できるMPEG-DASH Standardスキーマ形式のxmlドキュメントへのURLが含まれます。

関連する関数: GetVideoURL

定数

これらはISteamVideoで使用するために定義された定数です。

名前	型	値	説明
STEAMVIDEO_INTERFACE_VERSION	const char *	"STEAMVIDEO_INTERFACE_V002"