Live Events - Get

Referens

Tjänst:: Media Services

API-version:: 2022-11-01

Hämta livehändelse
Hämtar egenskaper för en livehändelse.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}?api-version=2022-11-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Media Services-kontonamnet.
liveEventName	path	True	string	Namnet på livehändelsen, maxlängden är 32. Reguljärt uttrycksmönster: `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$`
resourceGroupName	path	True	string	Namnet på resursgruppen i Azure-prenumerationen.
subscriptionId	path	True	string	Den unika identifieraren för en Microsoft Azure-prenumeration.
api-version	query	True	string	Den version av API:et som ska användas med klientbegäran.

Svar

Name	Typ	Description
200 OK	LiveEvent	OK. Begäran har slutförts.
Other Status Codes	ErrorResponse	Strömningsfelsvaret som beskriver varför åtgärden misslyckades.

Exempel

Get a LiveEvent by name

GET https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveEvents/myLiveEvent1?api-version=2022-11-01


/**
 * Samples for LiveEvents Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/liveevent-list-
     * by-name.json
     */
    /**
     * Sample code: Get a LiveEvent by name.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void getALiveEventByName(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.liveEvents().getWithResponse("mediaresources", "slitestmedia10", "myLiveEvent1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

Statuskod:: 200

{
  "name": "myLiveEvent1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1",
  "type": "Microsoft.Media/mediaservices/liveevents",
  "location": "West US",
  "tags": {},
  "properties": {
    "description": "",
    "resourceState": "Stopped",
    "provisioningState": "Succeeded",
    "created": "2018-03-03T02:25:08.3474032Z",
    "lastModified": "2018-03-03T02:25:08.3474032Z",
    "useStaticHostname": false,
    "streamOptions": [
      "Default"
    ],
    "input": {
      "keyFrameIntervalDuration": "PT6S",
      "streamingProtocol": "FragmentedMP4",
      "accessToken": null,
      "endpoints": [
        {
          "protocol": "FragmentedMP4",
          "url": "http://clouddeployment.media-test.net/ingest.isml"
        }
      ],
      "timedMetadataEndpoints": []
    },
    "preview": {
      "previewLocator": "763f3ea4-d94f-441c-a634-c833f61a4e04",
      "streamingPolicyName": null,
      "accessControl": {
        "ip": {
          "allow": [
            {
              "name": "AllowAll",
              "address": "0.0.0.0",
              "subnetPrefixLength": 0
            }
          ]
        }
      },
      "endpoints": [
        {
          "protocol": "FragmentedMP4",
          "url": "https://testeventopito4idh2r-weibzmedia05.preview-ts051.channel.media-test.windows-int.net/763f3ea4-d94f-441c-a634-c833f61a4e04/preview.ism/manifest"
        }
      ]
    },
    "encoding": {
      "encodingType": "None",
      "presetName": null
    },
    "crossSiteAccessPolicies": {
      "clientAccessPolicy": "<access-policy><cross-domain-access><policy><allow-from http-methods=\"*\"><domain uri=\"http://*\"/></allow-from><grant-to><resource path=\"/\" include-subpaths=\"true\"/></grant-to></policy></cross-domain-access></access-policy>",
      "crossDomainPolicy": "<cross-domain-policy><allow-access-from domain=\"*\" secure=\"false\" /></cross-domain-policy>"
    }
  }
}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
CrossSiteAccessPolicies	Klientåtkomstprincipen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
IPAccessControl	IP-åtkomstkontrollen.
IPRange	IP-adressintervallet i CIDR-schemat.
LiveEvent	Livehändelsen.
LiveEventEncoding	Anger livehändelsetyp och valfria kodningsinställningar för kodning av livehändelser.
LiveEventEncodingType	Livehändelsetyp. När encodingType är inställt på PassthroughBasic eller PassthroughStandard passerar tjänsten helt enkelt inkommande video- och ljudlager till utdata. När encodingType har angetts till Standard eller Premium1080p, kodar en livekodare den inkommande strömmen till flera bithastigheter eller lager. Mer information finns i https://go.microsoft.com/fwlink/?linkid=2095101. Det går inte att ändra den här egenskapen när livehändelsen har skapats.
LiveEventEndpoint	Livehändelseslutpunkten.
LiveEventInput	Livehändelsens indata.
LiveEventInputAccessControl	IP-åtkomstkontrollen för livehändelseindata.
LiveEventInputProtocol	Indataprotokollet för livehändelsen. Detta anges vid skapandetillfället och kan inte uppdateras.
LiveEventInputTrackSelection	Ett villkor för att spåra markering. Den här egenskapen är reserverad för framtida användning. Alla värden som anges i den här egenskapen ignoreras.
LiveEventOutputTranscriptionTrack	Beskriver ett transkriptionsspår i utdata från en livehändelse som genereras med tal-till-text-transkription. Den här egenskapen är reserverad för framtida användning. Alla värden som anges i den här egenskapen ignoreras.
LiveEventPreview	Inställningar för förhandsgranskning av livehändelser.
LiveEventPreviewAccessControl	IP-åtkomstkontrollen för livehändelsens förhandsgranskningsslutpunkt.
LiveEventResourceState	Resurstillståndet för livehändelsen. Mer information finns i https://go.microsoft.com/fwlink/?linkid=2139012.
LiveEventTimedMetadataEndpoint	Livehändelsens slutpunkt för metadatainfogning.
LiveEventTranscription	Beskriver transkriptionsspåren i utdata från en livehändelse som genereras med tal till text-transkription. Den här egenskapen är reserverad för framtida användning. Alla värden som anges för den här egenskapen ignoreras.
StreamOptionsFlag	De alternativ som ska användas för LiveEvent. Det här värdet anges vid skapandetillfället och kan inte uppdateras. Giltiga värden för matrisens postvärden är "Standard" och "LowLatency".
StretchMode	Anger hur indatavideon ska ändras så att den passar önskad utdataupplösning. Standardvärdet är Ingen
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CrossSiteAccessPolicies

Klientåtkomstprincipen.

Name	Typ	Description
clientAccessPolicy	string	Innehållet i clientaccesspolicy.xml som används av Silverlight.
crossDomainPolicy	string	Innehållet i crossdomain.xml som används av Silverlight.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

IPAccessControl

IP-åtkomstkontrollen.

Name	Typ	Description
allow	IPRange[]	Listan över tillåtna IP-adresser.

IPRange

IP-adressintervallet i CIDR-schemat.

Name	Typ	Description
address	string	IP-adressen.
name	string	Det egna namnet för IP-adressintervallet.
subnetPrefixLength	integer	Prefixlängden för nätmasken (se CIDR-notation).

LiveEvent

Livehändelsen.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.created	string	Tiden då livehändelsen skapades
properties.crossSiteAccessPolicies	CrossSiteAccessPolicies	Principer för åtkomst mellan webbplatser i livehändelser.
properties.description	string	En beskrivning av livehändelsen.
properties.encoding	LiveEventEncoding	Kodningsinställningar för livehändelsen. Den konfigurerar om en livekodare används för livehändelsen och inställningarna för livekodaren om den används.
properties.hostnamePrefix	string	När useStaticHostname är inställt på true anger hostnamePrefix den första delen av värdnamnet som tilldelats livehändelseförhandsgranskningen och matar in slutpunkter. Det slutliga värdnamnet är en kombination av det här prefixet, medietjänstkontots namn och en kort kod för Azure Media Services-datacentret.
properties.input	LiveEventInput	Inställningar för livehändelseindata. Den definierar hur livehändelsen tar emot indata från en bidragskodare.
properties.lastModified	string	Senaste ändringstid för livehändelsen.
properties.preview	LiveEventPreview	Inställningar för förhandsgranskning av livehändelser. Med förhandsversionen kan livehändelseproducenter förhandsgranska liveuppspelningsinnehållet utan att skapa några liveutdata.
properties.provisioningState	string	Etableringstillståndet för livehändelsen.
properties.resourceState	LiveEventResourceState	Resurstillståndet för livehändelsen. Mer information finns i https://go.microsoft.com/fwlink/?linkid=2139012.
properties.streamOptions	StreamOptionsFlag[]	De alternativ som ska användas för LiveEvent. Det här värdet anges när det skapas och kan inte uppdateras. Giltiga värden för matrisens postvärden är "Default" och "LowLatency".
properties.transcriptions	LiveEventTranscription[]	Inställningar för live-transkription för livehändelsen. Se https://go.microsoft.com/fwlink/?linkid=2133742 för mer information om funktionen för live-transkription.
properties.useStaticHostname	boolean	Anger om ett statiskt värdnamn ska tilldelas till livehändelseförhandsgranskningen och mata in slutpunkter. Det här värdet kan bara uppdateras om livehändelsen är i vänteläge
systemData	systemData	Systemmetadata som är relaterade till den här resursen.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

LiveEventEncoding

Anger livehändelsetyp och valfria kodningsinställningar för kodning av livehändelser.

Name	Typ	Description
encodingType	LiveEventEncodingType	Livehändelsetyp. När encodingType är inställt på PassthroughBasic eller PassthroughStandard skickar tjänsten helt enkelt igenom de inkommande video- och ljudskikten till utdata. När encodingType är inställt på Standard eller Premium1080p, kodar en livekodare den inkommande strömmen till flera bithastigheter eller lager. Mer information finns i https://go.microsoft.com/fwlink/?linkid=2095101. Det går inte att ändra den här egenskapen när livehändelsen har skapats.
keyFrameInterval	string	Använd ett ISO 8601-tidsvärde mellan 0,5 och 20 sekunder för att ange utdatafragmentets längd för video- och ljudspåren för en kodnings-livehändelse. Du kan till exempel använda PT2S för att ange 2 sekunder. För videospåret definierar det även nyckelramsintervallet, eller längden på en GoP (grupp med bilder). Om det här värdet inte har angetts för en kodnings-livehändelse är fragmentets varaktighet som standard 2 sekunder. Det går inte att ange värdet för direktsändningar av livehändelser.
presetName	string	Det valfria förinställda namnet för kodning, som används när encodingType inte är None. Det här värdet anges när det skapas och kan inte uppdateras. Om kodningstypen är inställd på Standard är standardförinställningen "Default720p". Om kodningstypen annars är inställd på Premium1080p är standardförinställningen "Default1080p".
stretchMode	StretchMode	Anger hur indatavideon ska ändras så att den passar önskade utdataupplösningar. Standardvärdet är Ingen

LiveEventEncodingType

Livehändelsetyp. När encodingType är inställt på PassthroughBasic eller PassthroughStandard passerar tjänsten helt enkelt inkommande video- och ljudlager till utdata. När encodingType har angetts till Standard eller Premium1080p, kodar en livekodare den inkommande strömmen till flera bithastigheter eller lager. Mer information finns i https://go.microsoft.com/fwlink/?linkid=2095101. Det går inte att ändra den här egenskapen när livehändelsen har skapats.

Name	Typ	Description
None	string	Detta är samma som PassthroughStandard, se beskrivningen nedan. Det här uppräkningsvärdet håller på att bli inaktuellt.
PassthroughBasic	string	Den inmatade strömmen passerar genom livehändelsen från bidragskodaren utan ytterligare bearbetning. I PassthroughBasic-läget är inmatningen begränsad till upp till 5 Mbit/s och endast 1 samtidiga liveutdata tillåts. Live-transkription är inte tillgängligt.
PassthroughStandard	string	Den inmatade strömmen passerar genom livehändelsen från bidragskodaren utan ytterligare bearbetning. Live-transkription är tillgänglig. Inmatningsbithastighetsgränser är mycket högre och upp till 3 samtidiga liveutdata tillåts.
Premium1080p	string	En livekodare för bidrag skickar en dataström med en bithastighet till livehändelsen och Media Services skapar flera bithastighetsströmmar. Utdata får inte överskrida 1080p i upplösning.
Standard	string	En livekodare för bidrag skickar en dataström med en bithastighet till livehändelsen och Media Services skapar flera bithastighetsströmmar. Utdata får inte överskrida 720p i upplösning.

LiveEventEndpoint

Livehändelseslutpunkten.

Name	Typ	Description
protocol	string	Slutpunktsprotokollet.
url	string	Slutpunkts-URL:en.

LiveEventInput

Livehändelsens indata.

Name	Typ	Description
accessControl	LiveEventInputAccessControl	Åtkomstkontroll för livehändelseindata.
accessToken	string	Ett UUID i strängform som unikt identifierar dataströmmen. Detta kan anges när du skapar det, men det går inte att uppdatera det. Om den utelämnas genererar tjänsten ett unikt värde.
endpoints	LiveEventEndpoint[]	Indataslutpunkterna för livehändelsen.
keyFrameIntervalDuration	string	ISO 8601 varaktighet för nyckelbildruteintervallets varaktighet för inmatningen. Det här värdet anger egenskapen EXT-X-TARGETDURATION i HLS-utdata. Du kan till exempel använda PT2S för att ange 2 sekunder. Lämna värdet tomt för att koda livehändelser.
streamingProtocol	LiveEventInputProtocol	Indataprotokollet för livehändelsen. Detta anges vid skapandet och kan inte uppdateras.
timedMetadataEndpoints	LiveEventTimedMetadataEndpoint[]	Metadataslutpunkterna för livehändelsen.

LiveEventInputAccessControl

IP-åtkomstkontrollen för livehändelseindata.

Name	Typ	Description
ip	IPAccessControl	Egenskaperna för IP-åtkomstkontroll.

LiveEventInputProtocol

Indataprotokollet för livehändelsen. Detta anges vid skapandetillfället och kan inte uppdateras.

Name	Typ	Description
FragmentedMP4	string	Smooth Streaming-indata skickas av bidragskodaren till livehändelsen.
RTMP	string	RTMP-indata skickas av bidragskodaren till livehändelsen.

LiveEventInputTrackSelection

Ett villkor för att spåra markering. Den här egenskapen är reserverad för framtida användning. Alla värden som anges i den här egenskapen ignoreras.

Name	Typ	Description
operation	string	Jämför åtgärden. Den här egenskapen är reserverad för framtida användning. Alla värden som anges i den här egenskapen ignoreras.
property	string	Egenskapsnamn att välja. Den här egenskapen är reserverad för framtida användning. Alla värden som anges i den här egenskapen ignoreras.
value	string	Egenskapsvärde att välja. Den här egenskapen är reserverad för framtida användning. Alla värden som anges i den här egenskapen ignoreras.

LiveEventOutputTranscriptionTrack

Beskriver ett transkriptionsspår i utdata från en livehändelse som genereras med tal-till-text-transkription. Den här egenskapen är reserverad för framtida användning. Alla värden som anges i den här egenskapen ignoreras.

Name	Typ	Description
trackName	string	Namnet på utdataspåret. Den här egenskapen är reserverad för framtida användning. Alla värden som anges i den här egenskapen ignoreras.

LiveEventPreview

Inställningar för förhandsgranskning av livehändelser.

Name	Typ	Description
accessControl	LiveEventPreviewAccessControl	Åtkomstkontrollen för livehändelseförhandsvisning.
alternativeMediaId	string	En alternativ medieidentifierare som är associerad med positioneraren för direktuppspelning som skapats för förhandsversionen. Det här värdet anges när det skapas och kan inte uppdateras. Identifieraren kan användas i CustomLicenseAcquisitionUrlTemplate eller CustomKeyAcquisitionUrlTemplate för StreamingPolicy som anges i fältet StreamingPolicyName.
endpoints	LiveEventEndpoint[]	Slutpunkterna för förhandsversionen. Dela inte förhandsgransknings-URL:en med livehändelsens målgrupp.
previewLocator	string	Identifieraren för förhandsgranskningslokaliseraren i Guid-format. Om du anger detta vid tidpunkten för skapandet kan anroparen känna till url:en för förhandsgranskningslokaliseraren innan händelsen skapas. Om den utelämnas genererar tjänsten en slumpmässig identifierare. Det går inte att uppdatera det här värdet när livehändelsen har skapats.
streamingPolicyName	string	Namnet på den strömningsprincip som används för förhandsversionen av livehändelsen. Det här värdet anges när det skapas och kan inte uppdateras.

LiveEventPreviewAccessControl

IP-åtkomstkontrollen för livehändelsens förhandsgranskningsslutpunkt.

Name	Typ	Description
ip	IPAccessControl	Egenskaperna för IP-åtkomstkontroll.

LiveEventResourceState

Resurstillståndet för livehändelsen. Mer information finns i https://go.microsoft.com/fwlink/?linkid=2139012.

Name	Typ	Description
Allocating	string	Allokeringsåtgärden anropades för livehändelsen och resurser etableras för den här livehändelsen. När allokeringen är klar övergår livehändelsen till StandBy-tillstånd.
Deleting	string	Livehändelsen tas bort. Ingen fakturering sker i det här tillfälliga tillståndet. Uppdateringar eller direktuppspelning tillåts inte under det här tillståndet.
Running	string	Livehändelseresurserna har allokerats, inmatnings- och förhandsversions-URL:er har genererats och de kan ta emot liveströmmar. Nu är faktureringen aktiv. Du måste uttryckligen anropa Stoppa på livehändelseresursen för att stoppa ytterligare fakturering.
StandBy	string	Livehändelseresurser har etablerats och är redo att starta. Faktureringen sker i det här tillståndet. De flesta egenskaper kan fortfarande uppdateras, men inmatning eller direktuppspelning tillåts inte under det här tillståndet.
Starting	string	Livehändelsen startas och resurser allokeras. Ingen fakturering sker i det här tillståndet. Uppdateringar eller direktuppspelning tillåts inte under det här tillståndet. Om ett fel inträffar återgår livehändelsen till tillståndet Stoppad.
Stopped	string	Det här är det ursprungliga tillståndet för livehändelsen efter skapandet (såvida inte autostarten har angetts till true.) Ingen fakturering sker i det här tillståndet. I det här tillståndet kan livehändelseegenskaperna uppdateras, men strömning tillåts inte.
Stopping	string	Livehändelsen stoppas och resurser avetablerades. Ingen fakturering sker i det här tillfälliga tillståndet. Uppdateringar eller direktuppspelning tillåts inte under det här tillståndet.

LiveEventTimedMetadataEndpoint

Livehändelsens slutpunkt för metadatainfogning.

Name	Typ	Description
url	string	URL:en för metadataslutpunkten.

LiveEventTranscription

Beskriver transkriptionsspåren i utdata från en livehändelse som genereras med tal till text-transkription. Den här egenskapen är reserverad för framtida användning. Alla värden som anges för den här egenskapen ignoreras.

Name	Typ	Description
inputTrackSelection	LiveEventInputTrackSelection[]	Tillhandahåller en mekanism för att välja ljudspåret i live-feeden för indata, som tal till text-transkription tillämpas på. Den här egenskapen är reserverad för framtida användning. Alla värden som anges för den här egenskapen ignoreras.
language	string	Anger vilket språk (språk) som ska användas för tal till text-transkription – det ska matcha det talade språket i ljudspåret. Värdet ska vara i BCP-47-format (t.ex. "en-US"). Mer https://go.microsoft.com/fwlink/?linkid=2133742 information om funktionen för live-transkription och listan över språk som stöds finns i .
outputTranscriptionTrack	LiveEventOutputTranscriptionTrack	Beskriver ett transkriptionsspår i utdata från en livehändelse som genereras med tal till text-transkription. Den här egenskapen är reserverad för framtida användning. Alla värden som anges för den här egenskapen ignoreras.

StreamOptionsFlag

De alternativ som ska användas för LiveEvent. Det här värdet anges vid skapandetillfället och kan inte uppdateras. Giltiga värden för matrisens postvärden är "Standard" och "LowLatency".

Name	Typ	Description
Default	string	Liveuppspelning utan särskilda svarstidsoptimeringar.
LowLatency	string	Livehändelsen ger svarstid från slutpunkt till slutpunkt genom att minska dess interna buffertar.
LowLatencyV2	string	Livehändelsen är optimerad för svarstid från slutpunkt till slutpunkt. Det här alternativet är endast tillgängligt för kodning av livehändelser med RTMP-indata. Utdata kan strömmas med HLS- eller DASH-format. Utdataarkivets eller DVR-bakåtspolningslängden är begränsad till 6 timmar. Använd strömalternativet "LowLatency" för alla andra scenarier.

StretchMode

Anger hur indatavideon ska ändras så att den passar önskad utdataupplösning. Standardvärdet är Ingen

Name	Typ	Description
AutoFit	string	Fyll utdata (med antingen letterbox eller pelarruta) för att uppfylla utdataupplösningen, samtidigt som du ser till att den aktiva videoregionen i utdata har samma proportioner som indata. Om indata till exempel är 1920x1080 och kodningsförinställningen frågar efter 1280x1280, kommer utdata att vara på 1280x1280, som innehåller en inre rektangel på 1280x720 i breddförhållandet 16:9, och pelarfältsregioner 280 bildpunkter bred till vänster och höger.
AutoSize	string	Åsidosätt utdataupplösningen och ändra den så att den matchar visningsproportionen för indata, utan utfyllnad. Om indata till exempel är 1920x1080 och kodningsförinställningen frågar efter 1280x1280 åsidosätts värdet i förinställningen och utdata blir 1280x720, vilket upprätthåller förhållandet för indataaspekten på 16:9.
None	string	Strikt respekterar utdataupplösningen som anges i kodningsförinställningen utan att beakta pixelproportionen eller visningsproportionen för indatavideon.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via