Share via

LiveEvent Class

  • Reference

The live event.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.media.models._models_py3.TrackedResource
LiveEvent

Constructor

LiveEvent(*, location: str, tags: Dict[str, str] | None = None, description: str | None = None, input: _models.LiveEventInput | None = None, preview: _models.LiveEventPreview | None = None, encoding: _models.LiveEventEncoding | None = None, transcriptions: List[_models.LiveEventTranscription] | None = None, cross_site_access_policies: _models.CrossSiteAccessPolicies | None = None, use_static_hostname: bool | None = None, hostname_prefix: str | None = None, stream_options: List[str | _models.StreamOptionsFlag] | None = None, **kwargs)

Keyword-Only Parameters

Name Description
tags
dict[str, str]

Resource tags.
location
str

The geo-location where the resource lives. Required.
description
str

A description for the live event.
input
LiveEventInput

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

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

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.
transcriptions
list[LiveEventTranscription]

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

Live event cross site access policies.
use_static_hostname
bool

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.
hostname_prefix
str

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.
stream_options
list[str or StreamOptionsFlag]

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'.

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
tags
dict[str, str]

Resource tags.
location
str

The geo-location where the resource lives. Required.
system_data
SystemData

The system metadata relating to this resource.
description
str

A description for the live event.
input
LiveEventInput

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

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

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.
transcriptions
list[LiveEventTranscription]

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

The provisioning state of the live event.
resource_state
str or LiveEventResourceState

The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. Known values are: "Stopped", "Allocating", "StandBy", "Starting", "Running", "Stopping", and "Deleting".
cross_site_access_policies
CrossSiteAccessPolicies

Live event cross site access policies.
use_static_hostname
bool

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.
hostname_prefix
str

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.
stream_options
list[str or StreamOptionsFlag]

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'.
created
datetime

The creation time for the live event.
last_modified
datetime

The last modified time of the live event.