チャネル
Azure Media Services (AMS) では、Channel エンティティはライブ ストリーミング コンテンツを処理するためのパイプラインを表します。 チャネルは、次の 2 つの方法のいずれかでライブ入力ストリームを受信します。
オンプレミスのライブ エンコーダーは、マルチビットレート
RTMPまたはSmooth Streaming(フラグメント化された MP4) をチャネルに送信します。 マルチビットレートのスムーズ ストリーミングを出力するライブ エンコーダーとして、MediaExcel、Imagine Communications、Ateme、Envivio、Cisco、Elemental を使用できます。 Adobe Flash Live Encoder、Haivision、Telestream Wirecast、Teradek、Tricaster エンコーダーは、RTMP を出力するライブ エンコーダーです。 取り込んだストリームは、追加の処理なしでチャネルを通過します。 Media Services は、要求に応じて、ストリームを顧客に配信します。(MPEG-TS)
RTMP、、またはSmooth Streaming(Fragmented MP4) のいずれかの形式RTPの単一ビットレート ストリームが、 にChannel送信され、Media Services でライブ エンコードが実行されます。 次に、Channelが、受信する単一のビットレート ストリームからマルチビットレート (アダプティブ) のビデオ ストリームへのライブ エンコードを実行します。 Media Services は、要求に応じて、ストリームを顧客に配信します。
Media Services 2.10 リリース以降、チャネルを作成するときに、チャネルで入力ストリームを受信する方法、およびチャネルでストリームのライブ エンコードを実行するかどうかを指定できます。 2 つのオプションがあります。
None– マルチビットレート ストリームを出力するオンプレミスのライブ エンコーダーを使用する予定の場合は、この値を指定します。 この場合は、受信ストリームはエンコードなしで出力に渡されます。 これは、2.10 リリースより前のチャネル動作です。 この種類のチャネルの操作の詳細については、「 オンプレミス エンコーダーからマルチビットレート ライブ ストリームを受信するチャネルの操作」を参照してください。Standard– Media Services を使用してシングル ビットレート ライブ ストリームをマルチビットレート ストリームにエンコードする場合は、この値を選択します。注意
ライブ エンコードは課金に影響することと、ライブ エンコード チャネルを "実行中" 状態のままにしておくと請求料金が課されることに注意してください。 余分な時間料金を課されないようにするために、ライブ ストリーミング イベントが完了したら、チャネルの実行をすぐに停止することをお勧めします。 詳細については、「 Azure Media Services を使用してライブ エンコードの実行が有効なチャネルを操作する」をご覧ください。
チャネルのライブ ストリーミングと管理の詳細については、「 Azure Media Services を使用したライブ ストリーミングの配信」を参照してください。
重要
Media Services でエンティティにアクセスするときは、HTTP 要求で特定のヘッダー フィールドと値を設定する必要があります。
詳細については、「 Media Services REST API 開発のセットアップ」および「Media Services REST APIを使用した Media Services への接続」を参照してください。
このトピックは、Channel エンティティを概説し、また Media Services REST API でさまざまな操作を実行する方法を示します。
Channel エンティティ
Channel エンティティには、次のプロパティが含まれています。
| プロパティ | Type | 説明 |
|---|---|---|
Id読み取り専用です。 Media Services で設定します。 |
Edm.String | 作成時に割り当てられる Channel ID。 形式は次のようになります: nb:chid:UUID:<GUID>。 |
Name |
Edm.String | Channel の名前。 1. Media Services アカウント内で一意である必要があります。 2. 最大長 = 32 文字。 3. スペースを含めることはできません。 4. ハイフンと英数字のみ。 5. ハイフンで始めたり終わったりすることはできません。 |
Created読み取り専用です。 Media Services で設定します。 |
Edm.DateTime | 作成日時を示す UTC 日付/時刻値。 |
Description |
Edm.String | ユーザーが入力する説明。 最大長は 256 文字です。 |
LastModified読み取り専用です。 Media Services で設定します。 |
Edm.DateTime | 最後にチャンネルが更新された日時。 |
State読み取り専用です。 Media Services で設定します。 |
Edm.String | チャンネルの現在の状態。 次の値を指定できます。 - 停止済み。 これは、チャネル作成後の初期状態です。 この状態で、チャネルのプロパティを更新できますが、ストリーミングは許可されていません。 - 開始中。 Channel を開始しています。 この状態の場合、更新やストリーミングはできません。 エラーが発生した場合、Channel は [Stopped] 状態に戻ります。 - 実行中。 チャネルは、ライブ ストリームを処理できます。 - 停止中。 チャネルを停止しています。 この状態の場合、更新やストリーミングはできません。 - 削除中。 チャネルが削除されました。 この状態の場合、更新やストリーミングはできません。 |
Input |
ChannelInput ComplexType | Channel の入力 (取り込み) 設定。 |
Output |
ChannelOutput ComplexType | Channel の出力設定。 |
Preview |
ChannelPreview ComplexType | Channel のプレビュー設定。 |
CrossSiteAccessPolicies |
CrossSiteAccessPolicies | クロス サイト アクセス ポリシー。 |
Programs読み取り専用です。 Media Services で設定します。 |
Programのコレクション。 | チャンネルに関連付けられたプログラムのコレクションへの参照。 |
EncodingType |
Edm.String | Optional. チャネルの構成について説明します。 使用できる値は、以下のとおりです。- None – これが既定値です。 この値を選択すると、受信するストリームはエンコードなしで出力に渡されます (これは 2.10 リリースより前の Channel の動作です)。- Standard受信シングル ビットレート ストリームはチャネルに送信され、システム プリセットを使用してマルチビットレート ストリームにトランスコードされます |
Encoding |
Encoding ComplexType | Azure ライブ エンコーダー設定。 |
Slate |
スレート | この設定は、チャネルの が Encoding Type に Standard設定されている場合にのみサポートされます。チャネル内のライブ エンコーダーは、スレート イメージに切り替えるように信号通知できます。 使用中のスレートを終了するように信号通知することもできます。 ライブ エンコーダーは、たとえば CM の時間のような特定の状況で、スレート イメージに切り替えて受信ビデオ信号をマスクするように構成できます。 そうしたスレートが構成されていない場合、広告による中断期間中に入力ビデオはマスクされません。 |
ChannelInput ComplexType
| 名前 | Type | Description |
|---|---|---|
KeyFrameInterval |
Edm.Time | EncoderType が Standard に設定されている場合、この値は無視されます。オンプレミスのライブ エンコーダーを使用してマルチビットレート ストリームを生成する場合、キー フレーム間隔は GOP 期間を指定します (その外部エンコーダーで使用されます)。 チャネルがこの受信ストリームを受信したら、スムーズ ストリーミング、DASH、HLS のいずれかの形式でライブ ストリームをクライアントの再生アプリケーションに配信できます。 ライブ ストリーミングの実行中、HLS は常に動的にパッケージ化されます。 既定では、Media Services は、ライブ エンコーダーから受信するキー フレーム間隔 (GOP (Group of Pictures) とも呼ばれます) に基づいて、HLS セグメントのパッケージ化比率 (セグメントあたりのフラグメント数) を自動的に計算します。 |
StreamingProtocol読み取り専用です。 |
Edm.String | エンコーダーの型を設定した後、取り込みプロトコルを設定できます。Encoder Typeが に設定されている場合、None有効なオプションは次のとおりです。- マルチビットレートフラグメント MP4 (スムーズ ストリーミング) - マルチビットレート RTMP Encoder Typeが にNone設定されている場合、単一ビットレートの RTMP または Smooth Streaming ライブ ストリームが送信される場合は有効ですが、望ましくありません。 チャネルはストリームに対する処理を行わないため、そのまま渡されますが、クライアント アプリケーションは単一ビットレート ストリームを取得します。Encoder Typeが に設定されている場合、Standard有効なオプションは次のとおりです。1. シングル ビットレートフラグメント MP4 (スムーズ ストリーミング) 2. シングル ビットレート RTMP 3. RTP (MPEG-TS): RTP 経由の MPEG-2 トランスポート ストリーム。 |
AccessControl |
ChannelInputAccessControl ComplexType | Channel の入力アクセス制御設定。 |
Endpoints読み取り専用です。 |
ChannelEndpoint ComplexType | Channel の入力エンドポイント。 Channel は後からライブ ストリームの取り込みに使用する入力エンドポイント (取り込み URL) を提供します。 チャネルは、ライブの入力ストリームを受信して、出力ストリームを 1 つまたは複数のストリーミング エンドポイント経由のストリーミングに利用できるようにします。 |
ChannelPreview ComplexType
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | Description |
|---|---|---|
AccessControl |
ChannelPreviewAccessControl ComplexType | Channel のプレビュー アクセス制御設定。 |
Endpoints読み取り専用です。 |
ChannelEndpoint ComplexType | Channel のプレビュー エンドポイント。 |
ChannelInputAccessControl ComplexType
| 名前 | Type | Description |
|---|---|---|
IP |
IPAccessControl | Channel の入力エンドポイントへの接続が許可された IP アドレス。 IP アドレスは、4 つの番号を持つ IpV4 アドレス、CIDR アドレス範囲のいずれかの形式である必要があります。 |
ChannelPreviewAccessControl ComplexType
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | Description |
|---|---|---|
IP |
IPAccessControl | Channel の入力エンドポイントへの接続が許可された IP アドレス。 IP アドレスは、4 つの番号を持つ IpV4 アドレス、CIDR アドレス範囲のいずれかの形式である必要があります。 |
IPAccessControl
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | Description |
|---|---|---|
| Allow | IPRange ComplexType | Channel の入力エンドポイントへの接続が許可された IP アドレス。 メモ： この値を null に設定すると、すべての IP ソース アドレスが接続できるようになります。 空の文字列 ("") に設定すると、どこからの接続も許可しません。 |
IPRange ComplexType
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | 説明 |
|---|---|---|
Name |
Edm.String | この IP 範囲のフレンドリ名。 |
Address |
Edm.String | サブネット表記の基本 IP アドレス (例: 192.168.0.1)。 |
SubnetPrefixLength |
Edm.Int32 | サブネット マスクの有効ビット数 (たとえば、IP アドレス 192.168.0.1/24 の場合は、24 が有効ビット数を表しています)。 |
ChannelEndpoint ComplexType
| 名前 | Type | 説明 |
|---|---|---|
Protocol |
Edm.String | Channel のストリーミング エンドポイント プロトコル。 |
Url |
Edm.String | Channel のストリーミング エンドポイント URL。 |
ChannelOutput ComplexType
この種類とそのプロパティの詳細については、「ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | Description |
|---|---|---|
Hls |
ChannelOutputHls ComplexType | HLS 固有の設定。 |
ChannelOutputHls ComplexType
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | Description |
|---|---|---|
FragmentsPerSegment |
Edm.Int16 | HTTP ライブ ストリーミング (HLS) セグメントあたりのフラグメント数 |
Encoding ComplexType
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | 説明 |
|---|---|---|
AdMarkerSource |
Edm.String | Ad マーカーの信号ソースを指定できます。 既定値は ですApi。これは、チャネル内のライブ エンコーダーが非同期 Ad Marker APIをリッスンする必要があることを示します。もう 1 つの有効なオプションは Scte35 (取り込みストリーミング プロトコルが When Scte35 がRTP (MPEG-TS).指定されている場合にのみ許可されます)、エンコーダーは入力 RTP (MPEG-TS) ストリームからの信号を解析SCTE-35します。 |
IgnoreCea708ClosedCaptions |
Edm.bool | Optional. 受信ビデオに埋め込まれている CEA 708 キャプション データをすべて無視するようにライブ エンコーダーに指示するオプション フラグです。 このフラグが false (既定値) に設定されている場合、エンコーダーは CEA 708 データを検出し、そのデータを出力ビデオ ストリームに再び挿入します。 |
VideoStream |
VideoStream | Optional. 入力ビデオ ストリームについて記述します。 このフィールドが指定されていない場合は、既定値が使用されます。 この設定を使用できるのは、入力ストリーミング プロトコルが RTP (MPEG-TS) に設定されている場合だけです。 |
AudioStreams |
AudioStreams | Optional. 入力オーディオ ストリームについて記述します。 このフィールドが指定されていない場合は、既定値が適用されます。 この設定を使用できるのは、入力ストリーミング プロトコルが RTP (MPEG-TS) に設定されている場合だけです。 |
SystemPreset |
Edm.String | エンコーダーのプリセットがこの Channel で使用されるように指定されます。 現在、使用できる値は Default720p (既定値) のみです。詳細については、「SystemPreset」を参照してください。 |
SystemPreset
Default720p は、ビデオを次の 6 つのレイヤーにエンコードすることを指定します。
| ビットレート | 幅 | [高さ] | 最大 FPS | プロファイル | 出力ストリーム名 |
|---|---|---|---|---|---|
| 3500 | 1280 | 720 | 30 | 高 | Video_1280x720_3500kbps |
| 2200 | 960 | 540 | 30 | 高 | Video_960x540_2200kbps |
| 1350 | 704 | 396 | 30 | 高 | Video_704x396_1350kbps |
| 850 | 512 | 288 | 30 | 高 | Video_512x288_850kbps |
| 550 | 384 | 216 | 30 | 高 | Video_384x216_550kbps |
| 200 | 340 | 192 | 30 | 高 | Video_340x192_200kbps |
オーディオは、ステレオの 64 kbps で AAC-LC に、サンプリング レート 44.1 kHz でエンコードされます。
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
VideoStream
入力ビデオ ストリームについて記述します。 このフィールドが指定されていない場合は、既定値が使用されます。 この設定を使用できるのは、入力ストリーミング プロトコルが RTP (MPEG-TS) に設定されている場合だけです。
| 名前 | Type | Description |
|---|---|---|
Index |
Edm.Int1 | チャネル内でライブ エンコーダーが処理する入力ビデオ ストリームを指定する、0 から始まるインデックスです。 この設定が適用されるのは、取り込みストリーミング プロトコルが RTP (MPEG-TS) の場合のみです。 既定値は 0 です。 シングル プログラム トランスポート ストリーム (SPTS) で送信することをお勧めします。 入力ストリームに複数のプログラムが含まれている場合、ライブ エンコーダーは、入力でプログラム マップ テーブル (PMT) を解析し、ストリーム種類名が MPEG-2 ビデオまたは H.264 の入力を特定し、PMT で指定された順序に配置します。 次に 0 から始まるインデックスを使用して、その配置内の n 番目のエントリを選択します。 |
Name |
Edm.String | Optional. この入力ビデオ ストリームの説明タグ。 |
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
AudioStreams
入力オーディオ ストリームについて記述します。 このフィールドが指定されていない場合は、既定値が適用されます。 この設定を使用できるのは、入力ストリーミング プロトコルが RTP (MPEG-TS) に設定されている場合だけです。
| 名前 | Type | Description |
|---|---|---|
Index |
Edm.Int16 | シングル プログラム トランスポート ストリーム (SPTS) で送信することをお勧めします。 入力ストリームに複数のプログラムが含まれている場合、チャネル内のライブ エンコーダーは、入力でプログラム マップ テーブル (PMT) を解析し、ストリーム種類名が MPEG-2 AAC ADTS、AC-3 System-A、AC-3 System-B、MPEG-2 プライベート PES、MPEG-1 オーディオ、MPEG-2 オーディオの入力を特定し、PMT で指定された順序に配置します。 次に 0 から始まるインデックスを使用して、その配置内の n 番目のエントリを選択します。 |
Name |
Edm.String | Optional. この入力オーディオ ストリームの説明タグ。 |
Language |
Edm.String | Optional. ISO 639-2 に準拠している、オーディオ ストリームの言語識別子 (例: ENG)。 存在しない場合の既定値は UND (未定義) です。チャネルに対する入力が MPEG-2 TS over RTP の場合には、最大で 8 個のオーディオ ストリーム セットを指定できます。 ただし、同じ値のインデックスに 2 つのエントリを割り当てることはできません。 |
エンコーダーへの入力が RTP による MPEG-2 TS である場合、最大 8 の {インデックス、名前、言語} のセットを指定できます。 ただし、同じ値のインデックスに 2 つのエントリを割り当てることはできません。 エンコーダーへの入力が RTMP または HTTP (Smooth Streaming) である場合、入力のオーディオ ストリームが 1 つしかありません。
スレート
この設定は、チャネルの が Encoding Type に Standard設定されている場合にのみサポートされます。
チャネル内のライブ エンコーダーは、スレート イメージに切り替えるように信号通知できます。 使用中のスレートを終了するように信号通知することもできます。
ライブ エンコーダーは、たとえば CM の時間のような特定の状況で、スレート イメージに切り替えて受信ビデオ信号をマスクするように構成できます。 そうしたスレートが構成されていない場合、広告による中断期間中に入力ビデオはマスクされません。
| 名前 | Type | Description |
|---|---|---|
InsertSlateOnAdMarker |
Edm.Bool | True に設定すると、この設定によりライブ エンコーダーが広告内にスレート画像を挿入するように構成されます。 既定値は、true です。 |
DefaultSlateAssetId |
Edm.String | Optional. スレート イメージを含む Media Services アセットの資産 ID を指定します。 既定値は Null です。Channel を作成する前に、最大解像度が 1920x1080、JPEG 形式、最大サイズ 3 MB のスレート画像を専用のアセットとしてアップロードする必要があります (その他のファイルをこのアセットに含めることはできません)。 ファイル名には *.jpg の拡張子を付ける必要があり、このアセット ファイルをそのアセットのプライマリ ファイルとしてマークする必要があります。 この資産をストレージで暗号化することはできません。 既定のスレートアセット ID が指定されておらず、広告マーカーにスレートを挿入するが true に設定されている場合、既定の Azure Media Services イメージを使用して入力ストリームがマスクされます。 |
この種類とそのプロパティの詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
Channel の作成
Channel は、POST HTTP 要求を使用し、プロパティ値を指定して作成できます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| POST | <https:// accountname.restv2>。<location.media.azure.net/api/Channels> | HTTP/1.1 |
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
POST https://testrest.cloudapp.net/api/Channels HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
次の要求本文は、ライブ エンコードが有効になっているチャネルを作成する方法を示しています。
{
"Id":null,
"Name":"testchannel001",
"Description":"",
"EncoderType":"Standard",
"Created":"0001-01-01T00:00:00",
"LastModified":"0001-01-01T00:00:00",
"State":null,
"Input":
{
"StreamingProtocol":"RTPMPEG2TS",
"AccessControl":
{
"IP":
{
"Allow":
[
{
"Name":"testName1",
"Address":"1.1.1.1",
"SubnetPrefixLength":24
}
]
}
},
"Endpoints":[]
},
"Encoding":
{
"SystemPreset":"Default720p",
"IgnoreCea708ClosedCaptions": false,
"AdMarkerSource": "Api",
"VideoStream":
{
"Index":1,
"Name":"Video stream"
},
"AudioStreams":
[
{
"Index":0,
"Name":"English audio stream",
"Language":"ENG"
},
{
"Index":1,
"Name":"Spanish audio stream",
"Language":"SPA"
}
]
},
"EncodingType": "Standard",
"Slate":
{
"InsertOnAdMarker":true,
"DefaultSlateAssetId": "nb:cid:UUID:01234567-0123-0123-0123-01234567"
},
"Preview":
{
"AccessControl":
{
"IP":
{
"Allow":
[
{
"Name":"testName1",
"Address":"1.1.1.1",
"SubnetPrefixLength":24
}
]
}
},
"Endpoints":[]
}
}
次の要求本文は、ライブ エンコードが有効になっていないチャネルをアカウントに作成する方法を示しています。
{
"Id":null,
"Name":"testchannel001",
"Description":"",
"Created":"0001-01-01T00:00:00",
"LastModified":"0001-01-01T00:00:00",
"State":null,
"Input":
{
"KeyFrameInterval":null,
"StreamingProtocol":"FragmentedMP4",
"AccessControl":
{
"IP":
{
"Allow":[{"Name":"testName1","Address":"1.1.1.1","SubnetPrefixLength":24}]
}
},
"Endpoints":[]
},
"Preview":
{
"AccessControl":
{
"IP":
{
"Allow":[{"Name":"testName1","Address":"1.1.1.1","SubnetPrefixLength":24}]
}
},
"Endpoints":[]
},
"Output":
{
"Hls":
{
"FragmentsPerSegment":1
}
},
"CrossSiteAccessPolicies":
{
"ClientAccessPolicy":null,
"CrossDomainPolicy":null
}
}
成功すると、応答本文に 202 Accepted ステータス コードと、作成されたエンティティの表記が返されます。
[202 受理されました] ステータス コードは非同期操作を示しています。この場合、操作 ID ヘッダー値は、Channel の開始や停止など、長時間実行処理のステータスのポーリングと追跡にも使用されます。 ステータスを取得するために、操作 ID ヘッダー値を操作エンティティに渡します。 詳細については、「 手動で Long-Running 操作をポーリングする」を参照してください。
Channel の開始
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| POST | <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channelid')/Start | HTTP/1.1 |
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
POST https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393')/Start HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
処理が正常に終了すると、[202 受理されました] ステータス コードが返されます。 [202 受理されました] ステータス コードは非同期操作を示しています。この場合、操作 ID ヘッダー値は、Channel の開始や停止など、長時間実行処理のステータスのポーリングと追跡にも使用されます。 ステータスを取得するために、操作 ID ヘッダー値を操作エンティティに渡します。 詳細については、「 手動で Long-Running 操作をポーリングする」を参照してください。
Channel の停止
Channel は、[Running] 状態の場合にのみ停止できます。これを実行するとチャンネル上のすべてのプログラムが停止します。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| POST | <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channelid')/Stop | HTTP/1.1 |
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
POST https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393')/Stop HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
処理が正常に終了すると、[202 受理されました] ステータス コードが返されます。 [202 受理されました] ステータス コードは非同期操作を示しています。この場合、操作 ID ヘッダー値は、Channel の開始や停止など、長時間実行処理のステータスのポーリングと追跡にも使用されます。 ステータスを取得するために、操作 ID ヘッダー値を操作エンティティに渡します。 詳細については、「 手動で Long-Running 操作をポーリングする」を参照してください。
Channel のリスト
Channel は、GET HTTP 要求を使用して取得できます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| GET | すべての Channel を取得する。 <https:// accountname.restv2>。<location.media.azure.net/api/Channels> 指定された Channel を取得する。 <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channelid') |
HTTP/1.1 |
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
GET https://testrest.cloudapp.net/api/Channels HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
成功した場合、この操作は 200 OK 状態コードと、Media Services アカウントで作成されたすべてのチャネルの一覧を返します。
Channel のリセット
ライブ プレゼンテーションのストリーミング全体にわたって維持される Channel のランタイム状態をリセットし、プレゼンテーションのリセットやエンコーダーの再構成が実行された場合に Channel を再利用できるようにします。 Reset を呼び出す前にすべての Program を停止します。 Reset は、[Running] 状態の Channel でのみ呼び出すことができます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| POST | <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channelid')/Reset | HTTP/1.1 |
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
POST https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393')/Reset HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
処理が正常に終了すると、[202 受理されました] ステータス コードが返されます。 [202 受理されました] ステータス コードは非同期操作を示しています。この場合、操作 ID ヘッダー値は、Channel の開始や停止など、長時間実行処理のステータスのポーリングと追跡にも使用されます。 ステータスを取得するために、操作 ID ヘッダー値を操作エンティティに渡します。 詳細については、「 手動で Long-Running 操作をポーリングする」を参照してください。
Channel の更新
既存の Channel でプロパティを更新します。 Channel は [Stopped] 状態の場合にのみ更新できます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| PATCH/PUT/MERGE これらの操作の詳細については、「 PATCH/PUT/MERGE」を参照してください。 |
<https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channelid') | HTTP/1.1 |
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
PATCH https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393') HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
要求本文:
"Encoding":{"IgnoreCea708ClosedCaptions": true}
更新を同期で完了すると、204 No Content ステータス コードが返されます。そうでない場合は、202 Accepted ステータス コードが返されます。 [202 受理されました] ステータス コードは非同期操作を示しています。この場合、操作 ID ヘッダー値は、Channel の開始や停止など、長時間実行処理のステータスのポーリングと追跡にも使用されます。 ステータスを取得するために、操作 ID ヘッダー値を操作エンティティに渡します。 詳細については、「 手動で Long-Running 操作をポーリングする」を参照してください。
広告の開始
ライブ エンコーダーは、POST HTTP 要求を使用し、要求の本文の StartAdvertisement Entity エンティティ で のプロパティ値を指定して、アドバタイズまたは商用中断を開始するように通知できます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| POST | <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channeled')/StartAdvertisement | HTTP/1.1 |
詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
StartAdvertisement エンティティ
このエンティティは、広告開始 API を表します。ライブ エンコーダーが出力ストリームに広告またはコマーシャルを挿入するための非同期呼び出しです。
詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | Description |
|---|---|---|
duration |
Edm.Duration | コマーシャルで中断する時間 (秒) です。 コマーシャルを開始するには、この値を 0 以外の正の値にします。 コマーシャルで中断している場合に、現在のコマーシャルによる中断期間と一致する CueId を指定して時間を 0 に設定すると、対象のコマーシャル期間がキャンセルされます。 |
cueId |
Edm.Int | ダウンストリーム アプリケーションが適切な処理を実行するために使用される、コマーシャルの一意の ID。 正の整数にする必要があります。 |
showSlate |
Edm.Bool | Optional. コマーシャル中に、既定のスレート画像に切り替える (そして、受信するビデオ フィードをマスクする) 必要がある Channel 内のライブ エンコーダーを示します。 既定値は false です。使用されるイメージは、チャネル作成時に既定のスレート資産 ID プロパティを使用して指定されたイメージになります。 |
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
POST https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393')/StartAdvertisement HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
本文
{
"duration":"PT45S",
"cueId":"67520935",
"showSlate":"true"
}
処理が正常に終了すると、[202 受理されました] ステータス コードが返されます。
広告の終了
ライブ エンコーダーは、POST HTTP 要求を使用して、進行中の広告またはコマーシャルの終了を合図することができます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| POST | <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channeled')/EndAdvertisement | HTTP/1.1 |
この呼び出しは、進行中の広告がある場合にのみ呼び出す必要があります。
詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
POST https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393')/EndAdvertisement HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
処理が正常に終了すると、[202 受理されました] ステータス コードが返されます。
スレートの表示
コマーシャル中に、既定のスレート画像に切り替える (そして、受信するビデオ フィードをマスクする) 必要がある Channel 内のライブ エンコーダーを示します。 既定値は false です。 使用されるイメージは、チャネル作成時に既定のスレート資産 ID プロパティを使用して指定されたイメージになります。
HTTP 要求の本文で ShowSlate エンティティ のプロパティを使用します。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| POST | <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channeled')/ShowSlate | HTTP/1.1 |
詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
ShowSlate エンティティ
詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
| 名前 | Type | Description |
|---|---|---|
duration |
Edm.Duration | スレートの期間 (秒単位) です。 スレートを開始するには、この値を 0 以外の正の値にします。 進行中のスレートがあり、0 の期間が指定されている場合、進行中のスレートは終了します。 |
assetId |
Edm.String | スレート イメージを含む Media Services アセットの資産 ID を指定します。 Channel を作成する前に、最大解像度が 1920x1080、JPEG 形式、最大サイズ 3 MB のスレート画像を専用のアセットとしてアップロードする必要があります (その他のファイルをこのアセットに含めることはできません)。 エンコーダーはいずれかの任意のスレート画像 (Channel を作成するときに、DefaultSlateAssetId プロパティで指定されたものだけではありません) への切り替えの合図を受けることができます。 |
DefaultSlateAssetId プロパティが指定されており、AssetId が指定されていない場合は、DefaultSlateAssetId 画像を使用して入力ストリームがマスクされます。 詳細については、「 スレート」を参照してください。
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
POST https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393')/ShowSlate HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
本文
{
"duration":"PT45S",
"assetId":"nb:cid:UUID:01234567-ABCD-ABCD-EFEF-01234567"
}
処理が正常に終了すると、[202 受理されました] ステータス コードが返されます。
スレートを非表示にする
ライブ エンコーダーは、POST HTTP 要求を使用して、進行中のスレートの終了の合図を受けることができます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| POST | <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channelid')/HideSlate | HTTP/1.1 |
この呼び出しは、進行中のスレートがある場合にのみ呼び出す必要があります。
詳細については、「 ライブ エンコードが有効になっているチャネルの概要」を参照してください。
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
POST https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393')/HideSlate HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
処理が正常に終了すると、[202 受理されました] ステータス コードが返されます。 [202 受理されました] ステータス コードは非同期操作を示しています。この場合、操作 ID ヘッダー値は、Channel の開始や停止など、長時間実行処理のステータスのポーリングと追跡にも使用されます。 ステータスを取得するために、操作 ID ヘッダー値を操作エンティティに渡します。 詳細については、「 手動で Long-Running 操作をポーリングする」を参照してください。
Channel の削除
Channel を削除します。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| DELETE | <https:// accountname.restv2>。<location.media.azure.net/api/Channels>('channelid') | HTTP/1.1 |
要求のサンプル
Fiddler の [Composer] タブで次の例を試すことができます。
最新 x-ms-version:の を取得するには、「 Media Services REST」を参照してください。
要求ヘッダー:
DELETE https://testrest.cloudapp.net/api/Channels('nb:chid:UUID:2c30f424-ab90-40c6-ba41-52a993e9d393') HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
x-ms-version: 2.19
Content-Type: application/json;odata=minimalmetadata
Host: <host URI>
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer <token value>
処理が正常に終了すると、[202 受理されました] ステータス コードが返されます。 [202 受理されました] ステータス コードは非同期操作を示しています。この場合、操作 ID ヘッダー値は、Channel の開始や停止など、長時間実行処理のステータスのポーリングと追跡にも使用されます。 ステータスを取得するために、操作 ID ヘッダー値を操作エンティティに渡します。 詳細については、「 手動で Long-Running 操作をポーリングする」を参照してください。