Programma
Met een kanaal kunt u het publiceren en opslaan van segmenten in een livestream beheren. Programma's kunnen gelijktijdig worden uitgevoerd. Hiermee kunt u verschillende onderdelen van de gebeurtenis naar behoefte publiceren en archiveren.
U kunt het aantal uren opgeven dat u de opgenomen inhoud voor het programma wilt bewaren door de ArchiveWindowLength eigenschap in te stellen (maximaal 25 uur). Clients kunnen de gearchiveerde inhoud gedurende het opgegeven aantal uren zoeken. Als het programma langer wordt uitgevoerd dan de opgegeven ArchiveWindowLength, wordt de oudere inhoud verwijderd. Zie de ArchiveWindowLength onderstaande documentatie voor meer informatie.
In dit onderwerp vindt u een overzicht van de Program entiteit en ziet u ook hoe u verschillende bewerkingen uitvoert met de Media Services REST API.
Belangrijk
Bij het openen van entiteiten in Media Services moet u specifieke headervelden en -waarden instellen in uw HTTP-aanvragen.
Zie Setup for Media Services REST API Development and Connect to Media Services with the Media Services REST API (Verbinding maken met Media Services met de Media Services REST API) voor meer informatie.
Eigenschappen van programma-entiteit
De entiteit Program bevat de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
IdAlleen-lezen. Ingesteld door Media Services. |
Edm.String | De programma-id, toegewezen bij het maken. De indeling is: nb:pgid:UUID:<GUID>. |
Name |
Edm.String | De naam van het programma. De maximale lengte is 256 tekens en kan bestaan uit Engelse tekens en cijfers, inclusief '-' en ' , zolang deze begint en eindigt met alfanumerieke tekens. |
AssetId |
Edm.String | De asset-id die moet worden gebruikt voor de verwerking van het programma. De eigenschap kan alleen worden bijgewerkt wanneer het programma de status Gestopt heeft. Een asset kan niet worden verwijderd als deze wordt gebruikt door een programma. U kunt een asset verwijderen nadat u het programma hebt verwijderd dat deze gebruikt. |
CreatedAlleen-lezen. Ingesteld door Media Services. |
Edm.DateTime | Een UTC-datum-/tijdwaarde die het tijdstip van het maken aangeeft. |
Description |
Edm.String | De gebruiker heeft een beschrijving opgegeven. De maximale lengte is 256 tekens. |
ArchiveWindowLengthVereist. |
Edm.Time | Het aantal uren dat u de opgenomen inhoud voor het programma wilt bewaren. Deze waarde kan worden ingesteld van minimaal 5 minuten tot maximaal 25 uur. Dit bepaalt ook de maximale hoeveelheid tijd die clients terug kunnen zoeken in de tijd vanaf de huidige live positie. Programma's kunnen in de opgegeven tijdsduur worden uitgevoerd, maar de inhoud die achter de lengte van het venster valt, wordt altijd verwijderd. De waarde van deze eigenschap bepaalt ook hoe lang de clientmanifesten kunnen groeien. Als u gearchiveerde inhoud wilt verwijderen, stopt u het programma en verwijdert u vervolgens de asset die aan het programma is gekoppeld. |
LastModifiedAlleen-lezen. Ingesteld door Media Services. |
Edm.DateTime | De datum en tijd van de laatste wijziging. |
ManifestName |
Edm.String | De naam van het manifestbestand, zonder extensie. Deze eigenschap kan alleen worden bijgewerkt wanneer het programma de status Gestopt heeft. |
StateAlleen-lezen. Ingesteld door Media Services. |
Edm.String | Hiermee haalt u de huidige status op. Mogelijke waarden zijn: -Gestopt. Nadat u een programma hebt gemaakt, heeft het de status Gestopt . In deze status kunnen de eigenschappen van het programma worden bijgewerkt, maar streamen is niet toegestaan. Het programma kan worden gestart, bijgewerkt of verwijderd uit deze status. -Beginnen. Het programma wordt gestart. Er zijn geen updates of streaming toegestaan tijdens deze status. -Met. Het programma kan livestreams verwerken en archiveren. -Stoppen. Het programma wordt gestopt. Er zijn geen updates of streaming toegestaan tijdens deze status. |
ChannelIdAlleen-lezen. Ingesteld door Media Services. |
Edm.String | De id van het bovenliggende kanaal van het programma. |
Channel |
Kanaal | Het bovenliggende kanaal van het programma dat is opgegeven door de ChannelId. |
Programma's maken
Maak een nieuw programma.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
| POST | <https:// accountnaam.restv2>.<location.media.azure.net/api/Programs> | HTTP/1.1 |
Voorbeeldaanvraag
U kunt het volgende voorbeeld uitproberen op het tabblad Componist van Fiddler.
Zie Media Services REST voor de nieuwste x-ms-version:versie.
Aanvraagheaders:
POST https://testrest.cloudapp.net/api/Programs 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>
Aanvraagtekst:
{"Id":null,"Name":"testprogram001","Description":"","Created":"0001-01-01T00:00:00","LastModified":"0001-01-01T00:00:00","ChannelId":"nb:chid:UUID:83bb19de-7abf-4907-9578-abe90adfbabe","AssetId":"nb:cid:UUID:bc495364-5357-42a1-9a9d-be54689cfae2","ArchiveWindowLength":"PT1H","State":null,"ManifestName":null}
Als dit lukt, wordt de statuscode 202 Geaccepteerd geretourneerd, samen met een weergave van de gemaakte entiteit in de antwoordtekst.
{"odata.metadata":"https://testrest.cloudapp.net/api/$metadata#Programs/@Element","Id":"nb:pgid:UUID:b870dd57-4b04-41b6-849d-b2470e50e7e6","Name":"testprogram001","Description":"","Created":"2014-08-11T18:12:27.8381256Z","LastModified":"2014-08-11T18:12:27.8381256Z","ChannelId":"nb:chid:UUID:83bb19de-7abf-4907-9578-abe90adfbabe","AssetId":"nb:cid:UUID:bc495364-5357-42a1-9a9d-be54689cfae2","ArchiveWindowLength":"PT1H","State":"Stopped","ManifestName":"f91329ec-26f5-4026-87f5-f5437d4da9e6"}
Notitie
Deze bewerking wordt synchroon voltooid, dus er is geen bewerkings-id om bij te houden.
Programma's starten
Start een programma. Een programma kan alleen worden gestart wanneer het de status Gestopt heeft en het kanaal de status Actief heeft.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
| Starten | <https:// accountnaam.restv2>.<location.media.azure.net/api/Programs>('ProgramId')/Start | HTTP/1.1 |
Voorbeeldaanvraag
U kunt het volgende voorbeeld uitproberen op het tabblad Componist van Fiddler.
Zie Media Services REST voor de nieuwste x-ms-version:versie.
Aanvraagheaders:
POST https://testrest.cloudapp.net/api/Programs('nb:pgid:UUID:0f9ceb51-50fe-4769-aaed-f8c19d76b9bc')/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>
Als dit lukt, wordt de statuscode 202 Geaccepteerd geretourneerd. De statuscode 202 Geaccepteerd geeft een asynchrone bewerking aan. In dat geval wordt de waarde van de header operation-id ook opgegeven voor het peilen en bijhouden van de status van langlopende bewerkingen, zoals het starten of stoppen van een programma. Geef de waarde van de operation-id-header door aan de bewerkingsentiteit om de status op te halen. Zie Handmatig polling Long-Running-bewerkingen voor meer informatie.
Programma's stoppen
Een programma stoppen. Een programma kan alleen worden gestopt wanneer het de status Actief heeft. Dit is een asynchrone bewerking.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
| Stoppen | <https:// accountnaam.restv2>.<location.media.azure.net/api/Programs>('ProgramId')/Stop | HTTP/1.1 |
Voorbeeldaanvraag
U kunt het volgende voorbeeld uitproberen op het tabblad Componist van Fiddler.
Zie Media Services REST voor de nieuwste x-ms-version:versie.
Aanvraagheaders:
POST https://testrest.cloudapp.net/api/Programs('nb:pgid:UUID:0f9ceb51-50fe-4769-aaed-f8c19d76b9bc')/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>
Als dit lukt, wordt de statuscode 202 Geaccepteerd geretourneerd. De statuscode 202 Geaccepteerd geeft een asynchrone bewerking aan. In dat geval wordt de waarde van de header operation-id ook opgegeven voor het peilen en bijhouden van de status van langlopende bewerkingen, zoals het starten of stoppen van een programma. Geef de waarde van de operation-id-header door aan de bewerkingsentiteit om de status op te halen. Zie Handmatig polling Long-Running-bewerkingen voor meer informatie.
Programma's weergeven
Programma's worden opgehaald met behulp van een GET HTTP-aanvraag.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
| GET | Alle programma's ophalen in het Media Services-account: <https:// accountnaam.restv2>.<location.media.azure.net/api/Programs> Een opgegeven programma ophalen in het Media Services-account: <https:// accountnaam.restv2>.<location.media.azure.net/api/Programs>('ProgramId') Alle programma's ophalen die zijn gekoppeld aan een opgegeven kanaal: <https:// accountnaam.restv2>.<location.media.azure.net/api/Channels>('channelid')/Programs |
HTTP/1.1 |
Voorbeeldaanvraag
U kunt het volgende voorbeeld uitproberen op het tabblad Componist van Fiddler.
Zie Media Services REST voor de nieuwste x-ms-version:versie.
Aanvraagheaders:
GET https://testrest.cloudapp.net/api/Programs 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>
Als dit lukt, retourneert deze bewerking de statuscode 200 OK en een lijst met alle programma's die in uw Media Services-account zijn gemaakt.
Programma's bijwerken
Een programma bijwerken. Het programma moet de status Gestopt hebben.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
| PATCH/PUT/MERGE Zie PATCH/PUT/MERGE voor meer informatie over deze bewerkingen. |
<https:// accountnaam.restv2>.<location.media.azure.net/api/Programs>('ProgramId') | HTTP/1.1 |
Voorbeeldaanvraag
U kunt het volgende voorbeeld uitproberen op het tabblad Componist van Fiddler.
Zie Media Services REST voor de nieuwste x-ms-version:versie.
Aanvraagheaders:
PATCH https://testrest.cloudapp.net/api/Programs('nb:pgid:UUID:0f9ceb51-50fe-4769-aaed-f8c19d76b9bc') 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>
Aanvraagtekst:
{"ArchiveWindowLength":"PT3H"}
Als de update synchroon wordt voltooid, wordt de statuscode 204 Geen inhoud geretourneerd. Anders wordt de statuscode 202 Geaccepteerd geretourneerd. De statuscode 202 Geaccepteerd geeft een asynchrone bewerking aan. In dat geval wordt de waarde van de header operation-id ook opgegeven voor het peilen en bijhouden van de status van langlopende bewerkingen, zoals het starten of stoppen van een programma. Geef de waarde van de operation-id-header door aan de bewerkingsentiteit om de status op te halen. Zie Handmatig polling Long-Running-bewerkingen voor meer informatie.
Programma's verwijderen
Een programma verwijderen. Een programma kan alleen worden verwijderd wanneer het de status Gestopt heeft.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
| DELETE | <https:// accountnaam.restv2>.<location.media.azure.net/api/Programs>('ProgramId') | HTTP/1.1 |
Voorbeeldaanvraag
U kunt het volgende voorbeeld uitproberen op het tabblad Componist van Fiddler.
Zie Media Services REST voor de nieuwste x-ms-version:versie.
Aanvraagheaders:
DELETE https://testrest.cloudapp.net/api/Programs('nb:pgid:UUID:0f9ceb51-50fe-4769-aaed-f8c19d76b9bc') 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>
Als dit lukt, wordt de statuscode 204 Geen inhoud geretourneerd.
Notitie
Deze bewerking wordt synchroon voltooid, dus er is geen bewerkings-id om bij te houden.