ITStream

ITStream インターフェイスは、ストリームに関する情報の取得、ストリームの開始・一時停止・停止、ストリーム上のターミナルの選択・選択解除、およびストリーム上で選択されているターミナルの一覧の取得をアプリケーションに可能にするメソッドを公開します。

get_MediaType メソッドは、ストリームのメディアタイプを取得します。

このメソッドは、次のいずれかの値を返すことがあります。

get_Direction メソッドは、ストリームのターミナルの方向を取得します。

このメソッドは、次のいずれかの値を返すことがあります。

一般に、どちらの方向のターミナルでも、そのターミナルのメディアタイプに一致するメディアタイプを持つ任意のストリーム上で選択できます。ただし、一部の MSP では、ターミナルの方向がストリームのターミナルの方向に一致するターミナルのみをストリーム上で選択できます。

get_Name メソッドは、ストリームの名前を表す BSTR を取得します。この名前は、情報提供または表示の目的で使用されます。

このメソッドは、次のいずれかの値を返すことがあります。

アプリケーションは、ppName パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

StartStream メソッドは、ストリームを開始します。

このメソッドは、次のいずれかの値を返すことがあります。

ストリームは、コールが接続されてストリーミングの準備が整い、ターミナルが選択されると、自動的に開始されます。そのため、ほとんどのアプリケーションはこのメソッドを呼び出す必要はありません。アプリケーションがこのメソッドを呼び出す必要があるのは、以前に ITStream::StopStream または ITStream::PauseStream を呼び出して停止または一時停止したストリームを開始する場合のみです。

この呼び出しは、アプリケーションが登録していれば取得できるイベントを生成します。イベントの受信については、 Events の概要を参照してください。

ストリームが正常に開始されると、MSP は値が CME_STREAM_ACTIVE の CALL_MEDIA_EVENT イベントを、CMC_LOCAL_REQUEST に等しい CALL_MEDIA_EVENT_CAUSE とともに発生させます。

ストリームの一時停止に失敗した場合、MSP は原因が CMC_LOCAL_REQUEST の CME_STREAM_FAIL イベントを発生させます。

PauseStream メソッドは、ストリームを一時停止します。

このメソッドは、次のいずれかの値を返すことがあります。

ストリームの一時停止と停止の違いは、トランスポートの種類によって異なります。

ストリームが正常に一時停止されると、MSP は値が CME_STREAM_INACTIVE の CALL_MEDIA_EVENT を、CMC_LOCAL_REQUEST に等しい CALL_MEDIA_EVENT_CAUSE とともに発生させる必要があります。

ストリームの一時停止に失敗した場合、イベントは原因が CMC_LOCAL_REQUEST の CME_STREAM_FAIL になります。

StartStream の呼び出しにより、ストリームが再開されます。

StopStream メソッドは、ストリームを停止します。

このメソッドは、次のいずれかの値を返すことがあります。

アプリケーションは、このメソッドを呼び出してストリームを停止できます。ストリームの一時停止とストリームの停止の違いは、コールに使用されるトランスポートの種類によって異なります。

この呼び出しは、アプリケーションが登録していれば取得できるイベントを生成します。イベントの受信については、 Events の概要を参照してください。

ストリームが正常に停止されると、アプリケーションは値が CME_STREAM_INACTIVE の CALL_MEDIA_EVENT イベントを、CMC_LOCAL_REQUEST に等しい CALL_MEDIA_EVENT_CAUSE とともに受け取ります。

ストリームの一時停止に失敗した場合、アプリケーションは原因が CMC_LOCAL_REQUEST の CME_STREAM_FAIL イベントを受け取ります。

その後ストリームを再開するには、アプリケーションは StartStream を呼び出す必要があります。

SelectTerminal メソッドは、ITTerminal オブジェクトをストリーム上に選択します。

このメソッドは、次のいずれかの値を返すことがあります。

ターミナルは、トランスポートがメディアをストリーミングできる状態にあるかどうかに関係なく、いつでも選択できます。トランスポートがメディアをストリーミングできる状態にあり、かつアプリケーションがそのストリームに対して ITStream::PauseStream または ITStream::StopStream を正常に呼び出していない場合、あるいはこのストリームに対して ITStream::PauseStream または ITStream::StopStream を正常に呼び出したときよりも新しく ITStream::StartStream を正常に呼び出している場合は、ターミナルが選択されるとすぐにストリーミングが自動的に開始されます。トランスポートがメディアをストリーミングできる状態に入る前にターミナルがストリーム上で選択され、その後 StopStream または PauseStream の呼び出しが行われなかった場合、トランスポートがメディアをストリーミングできる状態に入ると、ストリームは自動的に開始されます。

CME_STREAM_ACTIVE イベントは、ストリーミングが実際に開始されたときに生成されます。これは SelectTerminal の呼び出しよりも後になる場合があります。CME_STREAM_FAIL または CME_TERMINAL_FAIL イベントは、ストリーミングが実際に失敗したときに生成されます。これも SelectTerminal の呼び出しよりも後になる場合があります。

ターミナルをストリーム上に選択できるのは、 ITTerminal::get_MediaType の結果が ITStream::get_MediaType と一致する場合のみです。さらに、一部の MSP では、 ITTerminal::get_Direction と ITStream::get_Direction の一致を必要とする場合がありますが、インターフェイス自体はこれを強制しません。

一部の MSP では、同じストリーム上で同時に選択できるターミナルの数を一定数(通常は 1 つ)までに制限する場合がありますが、インターフェイス自体はそのような制限を強制しません。同じストリーム上で一度に複数のターミナルを選択することは、たとえば、着信するオーディオストリームをスピーカーのペアで聞きながら同時にファイルに録音できるようにするために役立ちます。

特定のターミナルは、1 つのストリームにのみ選択できます。

UnselectTerminal メソッドは、ストリームからターミナルの選択を解除し、このストリームのストリーミングを停止します。

このメソッドは、次のいずれかの値を返すことがあります。

伝送の遅延により、ストリーミングが停止された後に一部のストリームイベントを受け取ることがあります。

ストリームから最後のターミナルの選択を正常に解除すると、この特定のストリームに対する既存のストリーミングは事実上停止します。その後、同じターミナルまたは別のターミナルを選択すると、中断されたストリーミングが再開されます。

別のターミナルや新しく作成したターミナルをストリームに再選択すると、予期しない影響が生じることがあります。フィルターグラフが以前のターミナルの情報を保持しており、それが新しいターミナルと一致しない場合があります。

EnumerateTerminals メソッドは、ストリーム上で選択されているターミナルを列挙します。C および C++ アプリケーション向けに提供されています。Visual Basic などのオートメーションクライアントアプリケーションは、get_Terminals メソッドを使用する必要があります。

このメソッドは、次のいずれかの値を返すことがあります。

TAPI は、ITStream::EnumerateTerminals によって返された IEnumTerminal インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 IEnumTerminal インターフェイスに関連付けられたリソースを解放するために、そのインターフェイスに対して Release を呼び出す必要があります。

get_Terminals メソッドは、現在のストリームに関連付けられたターミナルのコレクションを作成します。Visual Basic で記述されたものなどのオートメーションクライアントアプリケーション向けに提供されています。C および C++ アプリケーションは、EnumerateTerminals メソッドを使用する必要があります。

このメソッドは、次のいずれかの値を返すことがあります。

TAPI は、ITStream::get_Terminals によって返された ITTerminal インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 ITTerminal インターフェイスに関連付けられたリソースを解放するために、そのインターフェイスに対して Release を呼び出す必要があります。