LiveEventPutSchema

Object

Properties

location

• Type: string (Optional)
• Description: Deprecated field. This field cannot be modified, only set during creation.

properties

• Type: object (LiveEventPutProperties) (Required)
• Description: The properties of the live event.

crossSiteAccessPolicies

• Type: object (CrossSiteAccessPolicies) (Optional)
• 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.

clientAccessPolicy

• Type: string or null (Optional)
• Description: The XML content of the client access policy file.

crossDomainPolicy

• Type: string or null (Optional)
• Description: The XML content of the cross-domain policy file.

description

• Type: string (Optional, 0-4096 characters)
• Description: An optional description for the live event. This field cannot be modified, only set during creation.

encoding

• Type: object (LiveEventEncoding) (Required)
• Description: The encoding configuration for the live event.

encodingType

• Type: enum (Required)
• Description: Live event type. Allowed values: None, PassthroughBasic, PassthroughStandard, Premium1080p, Standard.

keyFrameInterval

• Type: string (Optional, Defaults to PT2S)
• Description: Specifies the output fragment length for the video and audio tracks.

presetName

• Type: string (Optional)
• Description: A preset for alternative encoding templates.

stretchMode

• Type: enum (Optional)
• Description: Determines how aspect ratio will be preserved when there’s a mismatch between input and output ratios. Allowed values: None, AutoSize, AutoFit.

hostnamePrefix

• Type: string (Optional)
• Description: Applied when useStaticHostname=true.

input

• Type: object (LiveEventInput) (Required)
• Description: The configuration for the input of the live event.

accessControl

• Type: object (InputAccessControl) (Required)

ip

• Type: object (IPAccessControl) (Required)

allowlist

• Type: list of objects (IPRange) (Required)

• Description: The IP ranges that will be allowed to access the preview.

address

• Type: string (Required)
• Description: The IP address or DNS with port or protocol.

name

• Type: string (Required, 1-32 characters)
• Description: The name of the IP range.

subnetPrefixLength

• Type: integer (Required, 0 to 32)
• Description: The subnet prefix length.

accessToken

• Type: string (Required, 10-79 characters)
• Description: Unique identifier for the stream.

endpoints

• Type: list of objects (LiveEventEndpoint) (Optional)

keyFrameIntervalDuration

• Type: string (Required)
• Description: ISO 8601 duration of the key frame interval.

streamingProtocol

• Type: enum (Optional, Defaults to RTMP)
• Description: The input protocol for the live event. Allowed values: RTMP, RTPMSSRT.

timedMetadataEndpoints

• Type: list of objects (LiveEventTimedMetadataEndpoint) (Required)

url

• Type: string (Required)

pipeline

• Type: object (PipelineArguments) (Optional)

preview

• Type: object (LiveEventPreview) (Optional)
• Description: The configuration for the preview of the live event.

streamingPolicyName

• Type: string (Optional, <= 260 characters)
• Description: The name of the DRM streaming policy for the live event preview. Defaults to Predefined_ClearStreamingOnly.

streamOptions

• Type: list of strings (Required)
• Description: A list of streaming options for the live event.

useStaticHostname

• Type: boolean (Required)
• Description: Indicates whether a static hostname is assigned to input and preview endpoints.

tags

• Type: map from strings to string (Required)
• Description: A dictionary of tags associated with the live event.