LiveEventProperties

object

• created string Optional
  The time when the live event was created.

• crossSiteAccessPolicies object CrossSiteAccessPolicies Optional
  The configuration for cross-site access policies. This includes the XML content of the client access policy and cross-domain policy files.
  This field cannot be modified, only set during creation.

Show 2 properties Hide 2 properties

• clientAccessPolicy string or null Optional
  The XML content of the client access policy file. Search 'clientaccesspolicy.xml' to learn more.

• crossDomainPolicy string or null Optional
  The XML content of the cross-domain policy file. Search 'crossdomain.xml' to learn more.

• description string Optional
  An optional description for the live event.
  This field cannot be modified, only set during creation.

• encoding object LiveEventEncoding Required
  The encoding configuration for the live event. This includes settings like encoding type and preset name.
  This field cannot be modified, only set during creation.

Show 4 properties Hide 4 properties

• encodingType enum Required
  Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers
  Allowed values: None PassthroughBasic PassthroughStandard Premium1080p Standard

• keyFrameInterval string Optional
  Defaults to PT2S
  Use an ISO 8601 time value between 1 and 10 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events.

• presetName string Optional
  Defaults to either Default720p or Default1080p depending on encoding type. May be used to specify alternative encoding templates - contact support for assistance if your needs are complex.

• stretchMode enum Optional
  Determines how aspect ratio will be preserved when there is a mismatch between the input and output aspect ratios. Autofit to pad the output. Autosize to ignore the output ratio and pick the largest dimension that fits, and None to clip the content.
  Allowed values: None AutoSize AutoFit

• hostnamePrefix string Optional
  Applied when useStaticHostname=true to specify the first part of the hostname for all input and preview addresses.
  This field cannot be modified, only set during creation.

• input object LiveEventInput Required
  The configuration for the input of the live event. This includes settings like key frame interval duration, streaming protocol, access token, and endpoints.
  This field cannot be modified, only set during creation.

Show 6 properties Hide 6 properties

• accessControl object InputAccessControl Required
  Access control for live event input.

• ip object IPAccessControl Required
  The IP access control for the live event inputs.

Show 1 property Hide 1 property

• allowlist of objects IPRange Required
  The IP ranges that will be allowed to access the preview. If empty, all IPs will be allowed.

Show 3 properties Hide 3 properties

• address string Required
  The IP address or DNS with port or protocol

• name string Required
  The name of the IP range. This is for your reference only. examples: 'everyone', 'dave's house', 'corp vpn'.

• subnetPrefixLength integer Required
  The subnet prefix length (see CIDR notation).

• accessToken string Required
  For RTMP, a UUID in string form to uniquely identify the stream.
  For SRT, an arbitrary string of between 10 and 79 characters, used as the passphrase.
  This can be specified at creation time but cannot be updated.
  If omitted or null, the service will generate a unique value.

• endpoints list of objects LiveEventEndpoint Optional
  Populated server-side. The input endpoints for the live event.

Show 2 properties Hide 2 properties

• protocol string Optional
  The streaming protocol for the endpoint. Possible values include: 'SRT', 'RTMP'.

• url string Optional
  The IP address or DNS with port and protocol

• keyFrameIntervalDuration string Required
  ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events.

• streamingProtocol enum Optional
  Defaults to RTMP
  The input protocol for the live event.
  This is specified at creation time and cannot be updated.
  Allowed values: RTMP RTMPS SRT

• timedMetadataEndpoints list of objects LiveEventTimedMetadataEndpoint Required
  The metadata endpoints for the live event.

Show 1 property Hide 1 property

• url string Required

• lastModified string Optional
  The last time the live event was modified.

• pipeline object PipelineArguments Optional
  Not currently supported. AI pipeline settings

Show 2 properties Hide 2 properties

• arguments map from strings to list of objects ArgumentSchema Optional
  Arguments to each operation in the AI pipeline

Show value schema Hide value schema

• [any key] list of objects

Show 2 properties Hide 2 properties

• name string Required
  The name of the argument

• value any AnyValue Required
  The value of the argument

• name string Required
  The name of the AI pipeline the Transform will execute.

• preview object LiveEventPreview Optional
  The configuration for the preview of the live event. This includes settings like preview locator, streaming policy name, access control, and endpoints.
  This field cannot be modified, only set during creation.

Show 5 properties Hide 5 properties

• accessControl object PreviewAccessControl Optional
  Address-based ACLs for access to the preview.

Show 1 property Hide 1 property

• ip object IPAccessControl Required
  The IP access control for the preview endpoint. Determines who will be able to access preview content.

Show 1 property Hide 1 property

Show 3 properties Hide 3 properties

• address string Required
  The IP address or DNS with port or protocol

• name string Required
  The name of the IP range. This is for your reference only. examples: 'everyone', 'dave's house', 'corp vpn'.

• subnetPrefixLength integer Required
  The subnet prefix length (see CIDR notation).

• alternativeMediaId string Optional
  Not currently supported. Will be used to support DRM license acquisition for preview content.

• endpoints list of objects LiveEventEndpoint Optional
  Populated server-side. The endpoints that are used for previewing the live event.

Show 2 properties Hide 2 properties

• protocol string Optional
  The streaming protocol for the endpoint. Possible values include: 'SRT', 'RTMP'.

• url string Optional
  The IP address or DNS with port and protocol

• previewLocator string Optional
  format: uuid
  The ID of the locator for the preview. This is automatically generated when the live event is created, and removed when the live Event is deleted.
  The caller may specify a locator GUID, in which case the caller must ensure that the GUID is unique and not already used by another resource.

• streamingPolicyName string Optional
  <=260 characters Defaults to Predefined_ClearStreamingOnly
  The name of the DRM streaming policy for the live event preview. Defaults to Predefined_ClearStreamingOnly and no other value is presently supported.

• provisioningState string Optional
  The current provisioning state of the resource. One of 'InProgress', 'Succeeded', or 'Failed'

• resourceState enum Optional
  The current state of the resource. One of 'Stopped', 'Starting', 'Running', 'Stopping', or 'Deleting'.
  Allowed values: Stopped Starting Running Stopping Deleting

• streamOptions list of strings Required
  A list of streaming options for the live event. One of 'Default' or 'LowLatency'. Only one value permitted in the list.
  This field cannot be modified, only set during creation.

• transcriptions list of items AnyValue Optional
  Not currently supported. Transcription settings for the live event.
  This field cannot be modified, only set during creation.

• useStaticHostname boolean Required
  A boolean value that indicates whether a static hostname is assigned to input and preview endpoints. If not set, will default to 'false' and IP addresses will be provided.
  This field cannot be modified, only set during creation.