LiveEvent interface

Package:

@azure/arm-mediaservices

The live event.

Extends

TrackedResource

Properties

created	The creation time for the live event NOTE: This property will not be serialized. It can only be populated by the server.
crossSiteAccessPolicies	Live event cross site access policies.
description	A description for the live event.
encoding	Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used.
hostnamePrefix	When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center.
input	Live event input settings. It defines how the live event receives input from a contribution encoder.
lastModified	The last modified time of the live event. NOTE: This property will not be serialized. It can only be populated by the server.
preview	Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output.
provisioningState	The provisioning state of the live event. NOTE: This property will not be serialized. It can only be populated by the server.
resourceState	The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. NOTE: This property will not be serialized. It can only be populated by the server.
streamOptions	The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'.
systemData	The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
transcriptions	Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature.
useStaticHostname	Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

created

The creation time for the live event NOTE: This property will not be serialized. It can only be populated by the server.

created?: Date

Property Value

Date

crossSiteAccessPolicies

Live event cross site access policies.

crossSiteAccessPolicies?: CrossSiteAccessPolicies

Property Value

CrossSiteAccessPolicies

description

A description for the live event.

description?: string

Property Value

string

encoding

Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used.

encoding?: LiveEventEncoding

Property Value

LiveEventEncoding

hostnamePrefix

When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center.

hostnamePrefix?: string

Property Value

string

input

Live event input settings. It defines how the live event receives input from a contribution encoder.

input?: LiveEventInput

Property Value

LiveEventInput

lastModified

The last modified time of the live event. NOTE: This property will not be serialized. It can only be populated by the server.

lastModified?: Date

Property Value

Date

preview

Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output.

preview?: LiveEventPreview

Property Value

LiveEventPreview

provisioningState

The provisioning state of the live event. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceState

The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. NOTE: This property will not be serialized. It can only be populated by the server.

resourceState?: string

Property Value

string

streamOptions

The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'.

streamOptions?: string[]

Property Value

string[]

systemData

The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

transcriptions

Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature.

transcriptions?: LiveEventTranscription[]

Property Value

LiveEventTranscription[]

useStaticHostname

Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state

useStaticHostname?: boolean

Property Value

boolean

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type