Description: 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.
Properties: 2
clientAccessPolicy
Type: String or null
Description: The XML content of the client access policy file. Search 'clientaccesspolicy.xml' to learn more.
crossDomainPolicy
Type: String or null
Description: The XML content of the cross-domain policy file. Search 'crossdomain.xml' to learn more.
description
Type: String
Description: An optional description for the live event. This field cannot be modified, only set during creation.
Character Limit: 0-4096 characters
Encoding
LiveEventEncoding
Type: Object
Description: 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.
Properties: 4
encodingType
Type: Enum
Description: 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
Type: String
Description: 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.
presetName
Type: String
Description: Defaults to either Default720p or Default1080p depending on encoding type. May be used to specify alternative encoding templates.
stretchMode
Type: Enum
Description: Determines how aspect ratio will be preserved when there is a mismatch between the input and output aspect ratios.
Allowed Values: None, AutoSize, AutoFit
hostnamePrefix
Type: String
Description: 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
LiveEventInput
Type: Object
Description: 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.
Properties: 6
accessControl
Type: Object
Description: Access control for live event input.
ip
Type: Object
Description: The IP access control for the live event inputs.
allowlist
Type: List of objects
Description: The IP ranges that will be allowed to access the preview.
Properties: 3
address
Type: String
Description: The IP address or DNS with port or protocol.
name
Type: String
Description: The name of the IP range. This is for your reference only.
Character Limit: 1-32 characters
subnetPrefixLength
Type: Integer
Description: The subnet prefix length (see CIDR notation).
Range: 0 to 32
accessToken
Type: String
Description: For RTMP, a UUID in string form to uniquely identify the stream. For SRT, an arbitrary string of between 10 and 79 characters.
Character Limit: 10-79 characters
endpoints
Type: List of objects
Description: The input endpoints for the live event.
Properties: 2
protocol
Type: String
Description: The streaming protocol for the endpoint. Possible values include: 'SRT', 'RTMP'.
url
Type: String
Description: The IP address or DNS with port and protocol.
Key Frame Interval Duration
Type: String
Description: ISO 8601 time duration of the key frame interval duration of the input.
streamingProtocol
Type: Enum
Description: The input protocol for the live event.
Default: RTMP
Allowed Values: RTMP, RTMPS, SRT
timedMetadataEndpoints
Type: List of objects
Description: The metadata endpoints for the live event.
url
Type: String
Description: Required property.
Pipeline
pipeline
Type: Object
Description: Not currently supported. AI pipeline settings.
Properties: 2
arguments
Type: Map from strings to list of objects
Description: Arguments to each operation in the AI pipeline.
name
Type: String
Description: The name of the argument.
Character Limit: 1-260 characters
Pattern: ^[A-Za-z0-9_-]+$
value
Type: Any
Description: The value of the argument.
names
Type: String
Description: The name of the AI pipeline the Transform will execute.
Character Limit: 0-255 characters
Preview
preview
Type: Object
Description: The configuration for the preview of the live event.
accessControl
Type: Object
Description: Address-based ACLs for access to the preview.
ip
Type: Object
Description: The IP access control for the preview endpoint.
allowlist
Type: List of objects
Description: The IP ranges that will be allowed to access the preview.
address
Type: String
Description: The IP address or DNS with port or protocol.
name
Type: String
Description: The name of the IP range.
Character Limit: 1-32 characters
subnetPrefixLength
Type: Integer
Description: The subnet prefix length (see CIDR notation).
alternativeMediaId
Type: String
Description: Not currently supported. Will be used to support DRM license acquisition for preview content.
endpoints
Type: List of objects
Description: The endpoints that are used for previewing the live event.
protocol
Type: String
Description: The streaming protocol for the endpoint. Possible values include: 'SRT', 'RTMP'.
url
Type: String
Description: The IP address or DNS with port and protocol.
previewLocator
Type: String
Description: The ID of the locator for the preview. This is automatically generated when the live event is created.
streamingPolicyName
Type: String
Description: The name of the DRM streaming policy for the live event preview.
streamOptions
Type: List of strings
Description: A list of streaming options for the live event.
Values: 'Default' or 'LowLatency'
transcriptions
Type: List of items
Description: Not currently supported. Transcription settings for the live event.
useStaticHostname
Type: Boolean
Description: A boolean value that indicates whether a static hostname is assigned to input and preview endpoints.