オーディオ／ビデオストリーム。 続きを読む...

#include "config.h" #include "connection.h"
型定義
typedef struct otc_stream otc_stream
機能
const char * otc_stream_get_id (const otc_stream *ストリーム)
const char * otc_stream_get_name (const otc_stream *ストリーム)
otc_bool otc_stream_has_video_track (const otc_stream *ストリーム)
otc_bool otc_stream_has_video (const otc_stream *ストリーム)
otc_bool otc_stream_has_audio_track (const otc_stream *ストリーム)
otc_bool otc_stream_has_audio (const otc_stream *ストリーム)
otc_bool otc_stream_has_captions (const otc_stream *ストリーム)
otc_stream * otc_stream_copy (const otc_stream *ストリーム)
otc_status otc_stream_delete (otc_stream *ストリーム)
イント otc_stream_get_video_width (const otc_stream *ストリーム)
イント otc_stream_get_video_height (const otc_stream *ストリーム)
int64_t otc_stream_get_creation_time (const otc_stream *ストリーム)
enum otc_stream_video_type otc_stream_get_video_type (const otc_stream *ストリーム)
const otc_connection * otc_stream_get_connection (const otc_stream *ストリーム)

詳細な説明

オーディオ／ビデオストリーム。

このファイルには、オーディオ・ビデオストリームの型定義と、その処理に役立ついくつかの関数の宣言が含まれています。

Typedef のドキュメント

otc_stream
typedef struct otc_stream otc_stream

OpenTok セッションにおけるオーディオ・ビデオストリームを表す構造体の型定義。

列挙型のドキュメント

otc_stream_video_type

ストリーム動画タイプの列挙。

この列挙は、サポートされているさまざまなストリーム動画の種類を表しています。

調査員
OTC_STREAM_VIDEO_TYPE_CAMERA カメラの動画ストリーム。
OTC_STREAM_VIDEO_TYPE_SCREEN 画面の動画ストリーム。これは画面共有に使用されます。
OTC_STREAM_VIDEO_TYPE_CUSTOM カスタム動画ストリーム。

関数のドキュメント

otc_stream_copy()
otc_stream * otc_stream_copy ( const otc_stream * ストリーム )

ストリームのコピーを作成します。

パラメータ : | | | | --- | --- | | stream | コピーするストリーム。 |

戻り値 : ストリームのコピー。エラーが発生した場合は null になることがあります。

otc_stream_delete()
otc_status otc_stream_delete ( otc_stream * ストリーム )

ストリームに関連付けられたリソースを解放します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : エラーか成功かを示す戻り値。

otc_stream_get_connection()
const otc_connection * otc_stream_get_connection ( const otc_stream * ストリーム )

ストリームを配信しているクライアントに関連付けられた接続を取得します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : ストリームを配信しているクライアントに関連付けられた接続。

otc_stream_get_creation_time()
int64_t otc_stream_get_creation_time ( const otc_stream * ストリーム )

ストリームの作成時刻を取得します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : ストリームの作成時刻を示すタイムスタンプ。

otc_stream_get_id()
const char * otc_stream_get_id ( const otc_stream * ストリーム )

このストリームの一意の識別子を取得します。

パラメータ : | | | | --- | --- | | stream | ストリーム。 |

戻り値 : このストリームの一意の識別子。

otc_stream_get_name()
const char * otc_stream_get_name ( const otc_stream * ストリーム )

ストリームの名前を取得します。ストリームの発行者は、そのストリームを識別するためにこの名前を設定できます。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : ストリーム名。

otc_stream_get_video_height()
int otc_stream_get_video_height ( const otc_stream * ストリーム )

セッションに対して最後に通知された、パブリッシャーのキャプチャ対象解像度の高さをピクセル単位で返します。この値はすべてのセッション参加者にブロードキャストされ、パブリッシング側およびサブスクライビング側のクライアントの両方で読み取ることができます。

注：これはパブリッシャーのキャプチャ対象解像度を表すものであり、加入者が実際にエンコードまたは受信する解像度ではありません。パブリッシャーは、帯域幅やCPUの制約により、より低い解像度でエンコードする場合があります。

スケーラブルビデオ機能を使用して配信されるストリームの場合、この値は、そのストリームで利用可能な最大解像度の高さに設定されます。スケーラブルビデオの詳細については、 OpenTok メディアルーター.

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : パブリッシャーのキャプチャ対象解像度の高さ（ピクセル単位）。

otc_stream_get_video_type()
enum otc_stream_video_type otc_stream_get_video_type ( const otc_stream * ストリーム )

ストリームのビデオタイプを返します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : ストリームのビデオタイプ。

関連項目 ： otc_stream_video_type

otc_stream_get_video_width()
int otc_stream_get_video_width ( const otc_stream * ストリーム )

セッションに対して最後に通知された、パブリッシャーのキャプチャ対象解像度の幅をピクセル単位で返します。この値はすべてのセッション参加者にブロードキャストされ、パブリッシング側およびサブスクライビング側のクライアントの両方で読み取ることができます。

注：これはパブリッシャーのキャプチャ対象解像度を表すものであり、実際にエンコードされた解像度や加入者が受信する解像度ではありません。パブリッシャーは、帯域幅やCPUの制約により、より低い解像度でエンコードする場合があります。スケーラブルビデオ機能を使用して公開されるストリームの場合、これはそのストリームで利用可能な最大解像度の幅に設定されます。 スケーラブルビデオの詳細については、 OpenTok メディアルーター.

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : パブリッシャーのキャプチャ対象解像度の幅（ピクセル単位）。

otc_stream_has_audio()
otc_bool otc_stream_has_audio ( const otc_stream * ストリーム )

このストリームが現在オーディオを配信しているかどうかを確認します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : このストリームがオーディオを配信しているかどうかを示す戻り値。

otc_stream_has_audio_track()
otc_bool otc_stream_has_audio_track ( const otc_stream * ストリーム )

このストリームにオーディオトラックが含まれているかどうかを確認します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : このストリームにオーディオトラックが含まれているかどうかを示す戻り値。

otc_stream_has_captions()
otc_bool otc_stream_has_captions ( const otc_stream * ストリーム )

このストリームが現在、キャプションを配信しているかどうかを確認します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : このストリームがキャプションを配信しているかどうかを示す戻り値。

otc_stream_has_video()
otc_bool otc_stream_has_video ( const otc_stream * ストリーム )

このストリームが現在、動画を配信しているかどうかを確認します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : このストリームが動画を配信しているかどうかを示す戻り値。

otc_stream_has_video_track()
otc_bool otc_stream_has_video_track ( const otc_stream * ストリーム )

このストリームにビデオトラックが含まれているかどうかを確認します。

パラメータ : | | | | --- | --- | | stream | クエリの対象となるストリーム。 |

戻り値 : このストリームにビデオトラックが含まれているかどうかを示す戻り値。