Package-level declarations

Types

Link copied to clipboard
data class AacAudioResponse(val bitrate: Int? = null, val channels: Int? = null, val label: String? = null, val odataType: String, val profile: String? = null, val samplingRate: Int? = null)

Describes Advanced Audio Codec (AAC) audio encoding settings.

Link copied to clipboard
data class AbsoluteClipTimeResponse(val odataType: String, val time: String)

Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not.

Link copied to clipboard
data class AccessControlResponse(val defaultAction: String? = null, val ipAllowList: List<String>? = null)
Link copied to clipboard
data class AccountEncryptionResponse(val identity: ResourceIdentityResponse? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null, val status: String, val type: String)
Link copied to clipboard
data class AkamaiAccessControlResponse(val akamaiSignatureHeaderAuthenticationKeyList: List<AkamaiSignatureHeaderAuthenticationKeyResponse>? = null)

Akamai access control

data class AkamaiSignatureHeaderAuthenticationKeyResponse(val base64Key: String? = null, val expiration: String? = null, val identifier: String? = null)

Akamai Signature Header authentication key.

Link copied to clipboard
data class ArmStreamingEndpointCurrentSkuResponse(val capacity: Int? = null, val name: String)

The streaming endpoint current sku.

Link copied to clipboard
data class AssetFileEncryptionMetadataResponse(val assetFileId: String, val assetFileName: String? = null, val initializationVector: String? = null)

The Asset File Storage encryption metadata.

Link copied to clipboard
data class AssetStreamingLocatorResponse(val assetName: String, val created: String, val defaultContentKeyPolicyName: String, val endTime: String, val name: String, val startTime: String, val streamingLocatorId: String, val streamingPolicyName: String)

Properties of the Streaming Locator.

Link copied to clipboard
data class AudioAnalyzerPresetResponse(val audioLanguage: String? = null, val experimentalOptions: Map<String, String>? = null, val mode: String? = null, val odataType: String)

The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track.

Link copied to clipboard
data class AudioOverlayResponse(val audioGainLevel: Double? = null, val end: String? = null, val fadeInDuration: String? = null, val fadeOutDuration: String? = null, val inputLabel: String, val odataType: String, val start: String? = null)

Describes the properties of an audio overlay.

Link copied to clipboard
data class AudioResponse(val bitrate: Int? = null, val channels: Int? = null, val label: String? = null, val odataType: String, val samplingRate: Int? = null)

Defines the common properties for all audio codecs.

Link copied to clipboard
data class AudioTrackDescriptorResponse(val channelMapping: String? = null, val odataType: String)

A TrackSelection to select audio tracks.

Link copied to clipboard
data class AudioTrackResponse(val bitRate: Int, val dashSettings: DashSettingsResponse? = null, val displayName: String? = null, val fileName: String? = null, val hlsSettings: HlsSettingsResponse? = null, val languageCode: String? = null, val mpeg4TrackId: Int? = null, val odataType: String)

Represents an audio track in the asset.

Link copied to clipboard
data class BuiltInStandardEncoderPresetResponse(val configurations: PresetConfigurationsResponse? = null, val odataType: String, val presetName: String)

Describes a built-in preset for encoding the input video with the Standard Encoder.

Link copied to clipboard

Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy

Link copied to clipboard

Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy

Link copied to clipboard
data class ClearKeyEncryptionConfigurationResponse(val customKeysAcquisitionUrlTemplate: String? = null)

Class to specify ClearKey configuration of common encryption schemes in Streaming Policy

Link copied to clipboard
data class CommonEncryptionCbcsResponse(val clearKeyEncryptionConfiguration: ClearKeyEncryptionConfigurationResponse? = null, val clearTracks: List<TrackSelectionResponse>? = null, val contentKeys: StreamingPolicyContentKeysResponse? = null, val drm: CbcsDrmConfigurationResponse? = null, val enabledProtocols: EnabledProtocolsResponse? = null)

Class for CommonEncryptionCbcs encryption scheme

Link copied to clipboard
data class CommonEncryptionCencResponse(val clearKeyEncryptionConfiguration: ClearKeyEncryptionConfigurationResponse? = null, val clearTracks: List<TrackSelectionResponse>? = null, val contentKeys: StreamingPolicyContentKeysResponse? = null, val drm: CencDrmConfigurationResponse? = null, val enabledProtocols: EnabledProtocolsResponse? = null)

Class for envelope encryption scheme

Represents a configuration for non-DRM keys.

data class ContentKeyPolicyFairPlayConfigurationResponse(val ask: String, val fairPlayPfx: String, val fairPlayPfxPassword: String, val odataType: String, val offlineRentalConfiguration: ContentKeyPolicyFairPlayOfflineRentalConfigurationResponse? = null, val rentalAndLeaseKeyType: String, val rentalDuration: Double)

Specifies a configuration for FairPlay licenses.

data class ContentKeyPolicyFairPlayOfflineRentalConfigurationResponse(val playbackDurationSeconds: Double, val storageDurationSeconds: Double)
Link copied to clipboard

Represents an open restriction. License or key will be delivered on every request.

Link copied to clipboard
data class ContentKeyPolicyOptionResponse(val configuration: Any, val name: String? = null, val policyOptionId: String, val restriction: Any)

Represents a policy option.

data class ContentKeyPolicyPlayReadyConfigurationResponse(val licenses: List<ContentKeyPolicyPlayReadyLicenseResponse>, val odataType: String, val responseCustomData: String? = null)

Specifies a configuration for PlayReady licenses.

Specifies that the content key ID is in the PlayReady header.

Specifies that the content key ID is specified in the PlayReady configuration.

data class ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestrictionResponse(val bestEffort: Boolean, val configurationData: Int)

Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules.

Link copied to clipboard
data class ContentKeyPolicyPlayReadyLicenseResponse(val allowTestDevices: Boolean, val beginDate: String? = null, val contentKeyLocation: Either<ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeaderResponse, ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifierResponse>, val contentType: String, val expirationDate: String? = null, val gracePeriod: String? = null, val licenseType: String, val playRight: ContentKeyPolicyPlayReadyPlayRightResponse? = null, val relativeBeginDate: String? = null, val relativeExpirationDate: String? = null, val securityLevel: String? = null)

The PlayReady license

data class ContentKeyPolicyPlayReadyPlayRightResponse(val agcAndColorStripeRestriction: Int? = null, val allowPassingVideoContentToUnknownOutput: String, val analogVideoOpl: Int? = null, val compressedDigitalAudioOpl: Int? = null, val compressedDigitalVideoOpl: Int? = null, val digitalVideoOnlyContentRestriction: Boolean, val explicitAnalogTelevisionOutputRestriction: ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestrictionResponse? = null, val firstPlayExpiration: String? = null, val imageConstraintForAnalogComponentVideoRestriction: Boolean, val imageConstraintForAnalogComputerMonitorRestriction: Boolean, val scmsRestriction: Int? = null, val uncompressedDigitalAudioOpl: Int? = null, val uncompressedDigitalVideoOpl: Int? = null)

Configures the Play Right in the PlayReady license.

Link copied to clipboard
data class ContentKeyPolicyRsaTokenKeyResponse(val exponent: String, val modulus: String, val odataType: String)

Specifies a RSA key for token validation

data class ContentKeyPolicySymmetricTokenKeyResponse(val keyValue: String, val odataType: String)

Specifies a symmetric key for token validation.

Link copied to clipboard
data class ContentKeyPolicyTokenClaimResponse(val claimType: String? = null, val claimValue: String? = null)

Represents a token claim.

Link copied to clipboard
data class ContentKeyPolicyTokenRestrictionResponse(val alternateVerificationKeys: List<Any>? = null, val audience: String, val issuer: String, val odataType: String, val openIdConnectDiscoveryDocument: String? = null, val primaryVerificationKey: Any, val requiredClaims: List<ContentKeyPolicyTokenClaimResponse>? = null, val restrictionTokenType: String)

Represents a token restriction. Provided token must match these requirements for successful license or key delivery.

Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version.

Represents a ContentKeyPolicyRestriction that is unavailable in the current API version.

data class ContentKeyPolicyWidevineConfigurationResponse(val odataType: String, val widevineTemplate: String)

Specifies a configuration for Widevine licenses.

data class ContentKeyPolicyX509CertificateTokenKeyResponse(val odataType: String, val rawBody: String)

Specifies a certificate for token validation.

Link copied to clipboard
data class CopyAudioResponse(val label: String? = null, val odataType: String)

A codec flag, which tells the encoder to copy the input audio bitstream.

Link copied to clipboard
data class CopyVideoResponse(val label: String? = null, val odataType: String)

A codec flag, which tells the encoder to copy the input video bitstream without re-encoding.

Link copied to clipboard
data class CrossSiteAccessPoliciesResponse(val clientAccessPolicy: String? = null, val crossDomainPolicy: String? = null)

The client access policy.

Link copied to clipboard
data class DashSettingsResponse(val role: String? = null)

The DASH setting for a track.

Link copied to clipboard
data class DDAudioResponse(val bitrate: Int? = null, val channels: Int? = null, val label: String? = null, val odataType: String, val samplingRate: Int? = null)

Describes Dolby Digital Audio Codec (AC3) audio encoding settings. The current implementation for Dolby Digital Audio support are: Audio channel numbers at 1((mono), 2(stereo), 6(5.1side); Audio sampling frequency rates at: 32K/44.1K/48K Hz; Audio bitrate values as AC3 specification supports: 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000, 384000, 448000, 512000, 576000, 640000 bps.

Link copied to clipboard
data class DefaultKeyResponse(val label: String? = null, val policyName: String? = null)

Class to specify properties of default content key for each encryption scheme

Link copied to clipboard
data class DeinterlaceResponse(val mode: String? = null, val parity: String? = null)

Describes the de-interlacing settings.

Link copied to clipboard
data class EdgeUsageDataCollectionPolicyResponse(val dataCollectionFrequency: String? = null, val dataReportingFrequency: String? = null, val eventHubDetails: EdgeUsageDataEventHubResponse? = null, val maxAllowedUnreportedUsageDuration: String? = null)
Link copied to clipboard
data class EdgeUsageDataEventHubResponse(val name: String? = null, val namespace: String? = null, val token: String? = null)
Link copied to clipboard
data class EnabledProtocolsResponse(val dash: Boolean, val download: Boolean, val hls: Boolean, val smoothStreaming: Boolean)

Class to specify which protocols are enabled

Link copied to clipboard
data class EnvelopeEncryptionResponse(val clearTracks: List<TrackSelectionResponse>? = null, val contentKeys: StreamingPolicyContentKeysResponse? = null, val customKeyAcquisitionUrlTemplate: String? = null, val enabledProtocols: EnabledProtocolsResponse? = null)

Class for EnvelopeEncryption encryption scheme

Link copied to clipboard
data class FaceDetectorPresetResponse(val blurType: String? = null, val experimentalOptions: Map<String, String>? = null, val mode: String? = null, val odataType: String, val resolution: String? = null)

Describes all the settings to be used when analyzing a video in order to detect (and optionally redact) all the faces present.

Link copied to clipboard
data class FadeResponse(val duration: String, val fadeColor: String, val start: String? = null)

Describes the properties of a Fade effect applied to the input media.

Link copied to clipboard
data class FiltersResponse(val crop: RectangleResponse? = null, val deinterlace: DeinterlaceResponse? = null, val fadeIn: FadeResponse? = null, val fadeOut: FadeResponse? = null, val overlays: List<Either<AudioOverlayResponse, VideoOverlayResponse>>? = null, val rotation: String? = null)

Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding.

Link copied to clipboard
data class FilterTrackPropertyConditionResponse(val operation: String, val property: String, val value: String)

The class to specify one track property condition.

Link copied to clipboard

Representing a list of FilterTrackPropertyConditions to select a track. The filters are combined using a logical AND operation.

Link copied to clipboard
data class FirstQualityResponse(val bitrate: Int)

Filter First Quality

Link copied to clipboard
data class FromAllInputFileResponse(val includedTracks: List<Any>? = null, val odataType: String)

An InputDefinition that looks across all of the files provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to allow selection of a single track across a set of input files.

Link copied to clipboard
data class FromEachInputFileResponse(val includedTracks: List<Any>? = null, val odataType: String)

An InputDefinition that looks at each input file provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to select tracks from each file given.

Link copied to clipboard
data class GetAccountFilterResult(val firstQuality: FirstQualityResponse? = null, val id: String, val name: String, val presentationTimeRange: PresentationTimeRangeResponse? = null, val systemData: SystemDataResponse, val tracks: List<FilterTrackSelectionResponse>? = null, val type: String)

An Account Filter.

Link copied to clipboard
data class GetAssetEncryptionKeyResult(val assetFileEncryptionMetadata: List<AssetFileEncryptionMetadataResponse>? = null, val key: String? = null)

Data needed to decrypt asset files encrypted with legacy storage encryption.

Link copied to clipboard
data class GetAssetFilterResult(val firstQuality: FirstQualityResponse? = null, val id: String, val name: String, val presentationTimeRange: PresentationTimeRangeResponse? = null, val systemData: SystemDataResponse, val tracks: List<FilterTrackSelectionResponse>? = null, val type: String)

An Asset Filter.

Link copied to clipboard
data class GetAssetResult(val alternateId: String? = null, val assetId: String, val container: String? = null, val created: String, val description: String? = null, val encryptionScope: String? = null, val id: String, val lastModified: String, val name: String, val storageAccountName: String? = null, val storageEncryptionFormat: String, val systemData: SystemDataResponse, val type: String)

An Asset.

data class GetContentKeyPolicyPropertiesWithSecretsResult(val created: String, val description: String? = null, val lastModified: String, val options: List<ContentKeyPolicyOptionResponse>, val policyId: String)

The properties of the Content Key Policy.

Link copied to clipboard
data class GetContentKeyPolicyResult(val created: String, val description: String? = null, val id: String, val lastModified: String, val name: String, val options: List<ContentKeyPolicyOptionResponse>, val policyId: String, val systemData: SystemDataResponse, val type: String)

A Content Key Policy resource.

Link copied to clipboard
data class GetJobResult(val correlationData: Map<String, String>? = null, val created: String, val description: String? = null, val endTime: String, val id: String, val input: Any, val lastModified: String, val name: String, val outputs: List<JobOutputAssetResponse>, val priority: String? = null, val startTime: String, val state: String, val systemData: SystemDataResponse, val type: String)

A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid.

Link copied to clipboard
data class GetLiveEventResult(val created: String, val crossSiteAccessPolicies: CrossSiteAccessPoliciesResponse? = null, val description: String? = null, val encoding: LiveEventEncodingResponse? = null, val hostnamePrefix: String? = null, val id: String, val input: LiveEventInputResponse, val lastModified: String, val location: String, val name: String, val preview: LiveEventPreviewResponse? = null, val provisioningState: String, val resourceState: String, val streamOptions: List<String>? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val transcriptions: List<LiveEventTranscriptionResponse>? = null, val type: String, val useStaticHostname: Boolean? = null)

The live event.

Link copied to clipboard
data class GetLiveEventStatusResult(val value: List<LiveEventStatusResponse>? = null)

Get live event status result.

Link copied to clipboard

Get live event stream events result.

Link copied to clipboard

Get live event track ingest heart beats result.

Link copied to clipboard
data class GetLiveOutputResult(val archiveWindowLength: String, val assetName: String, val created: String, val description: String? = null, val hls: HlsResponse? = null, val id: String, val lastModified: String, val manifestName: String? = null, val name: String, val outputSnapTime: Double? = null, val provisioningState: String, val resourceState: String, val rewindWindowLength: String? = null, val systemData: SystemDataResponse, val type: String)

The Live Output.

Link copied to clipboard
data class GetMediaGraphResult(val created: String, val description: String? = null, val id: String, val lastModified: String, val name: String, val sinks: List<MediaGraphAssetSinkResponse>, val sources: List<MediaGraphRtspSourceResponse>, val state: String, val type: String)

The Media Graph.

Link copied to clipboard
data class GetMediaServiceResult(val encryption: AccountEncryptionResponse? = null, val id: String, val identity: MediaServiceIdentityResponse? = null, val keyDelivery: KeyDeliveryResponse? = null, val location: String, val mediaServiceId: String, val minimumTlsVersion: String? = null, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val storageAccounts: List<StorageAccountResponse>? = null, val storageAuthentication: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A Media Services account.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class GetStreamingEndpointResult(val accessControl: StreamingEndpointAccessControlResponse? = null, val availabilitySetName: String? = null, val cdnEnabled: Boolean? = null, val cdnProfile: String? = null, val cdnProvider: String? = null, val created: String, val crossSiteAccessPolicies: CrossSiteAccessPoliciesResponse? = null, val customHostNames: List<String>? = null, val description: String? = null, val freeTrialEndTime: String, val hostName: String, val id: String, val lastModified: String, val location: String, val maxCacheAge: Double? = null, val name: String, val provisioningState: String, val resourceState: String, val scaleUnits: Int, val sku: ArmStreamingEndpointCurrentSkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The streaming endpoint.

Link copied to clipboard
data class GetStreamingLocatorResult(val alternativeMediaId: String? = null, val assetName: String, val contentKeys: List<StreamingLocatorContentKeyResponse>? = null, val created: String, val defaultContentKeyPolicyName: String? = null, val endTime: String? = null, val filters: List<String>? = null, val id: String, val name: String, val startTime: String? = null, val streamingLocatorId: String? = null, val streamingPolicyName: String, val systemData: SystemDataResponse, val type: String)

A Streaming Locator resource

Link copied to clipboard
data class GetStreamingPolicyResult(val commonEncryptionCbcs: CommonEncryptionCbcsResponse? = null, val commonEncryptionCenc: CommonEncryptionCencResponse? = null, val created: String, val defaultContentKeyPolicyName: String? = null, val envelopeEncryption: EnvelopeEncryptionResponse? = null, val id: String, val name: String, val noEncryption: NoEncryptionResponse? = null, val systemData: SystemDataResponse, val type: String)

A Streaming Policy resource

Link copied to clipboard
data class GetTrackResult(val id: String, val name: String, val provisioningState: String, val track: Any? = null, val type: String)

An Asset Track resource.

Link copied to clipboard
data class GetTransformResult(val created: String, val description: String? = null, val id: String, val lastModified: String, val name: String, val outputs: List<TransformOutputResponse>, val systemData: SystemDataResponse, val type: String)

A Transform encapsulates the rules or instructions for generating desired outputs from input media, such as by transcoding or by extracting insights. After the Transform is created, it can be applied to input media by creating Jobs.

Link copied to clipboard
data class H264LayerResponse(val adaptiveBFrame: Boolean? = null, val bFrames: Int? = null, val bitrate: Int, val bufferWindow: String? = null, val crf: Double? = null, val entropyMode: String? = null, val frameRate: String? = null, val height: String? = null, val label: String? = null, val level: String? = null, val maxBitrate: Int? = null, val profile: String? = null, val referenceFrames: Int? = null, val slices: Int? = null, val width: String? = null)

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec.

Link copied to clipboard
data class H264VideoResponse(val complexity: String? = null, val keyFrameInterval: String? = null, val label: String? = null, val layers: List<H264LayerResponse>? = null, val odataType: String, val rateControlMode: String? = null, val sceneChangeDetection: Boolean? = null, val stretchMode: String? = null, val syncMode: String? = null)

Describes all the properties for encoding a video with the H.264 codec.

Link copied to clipboard
data class H265LayerResponse(val adaptiveBFrame: Boolean? = null, val bFrames: Int? = null, val bitrate: Int, val bufferWindow: String? = null, val crf: Double? = null, val frameRate: String? = null, val height: String? = null, val label: String? = null, val level: String? = null, val maxBitrate: Int? = null, val profile: String? = null, val referenceFrames: Int? = null, val slices: Int? = null, val width: String? = null)

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.265 video codec.

Link copied to clipboard
data class H265VideoResponse(val complexity: String? = null, val keyFrameInterval: String? = null, val label: String? = null, val layers: List<H265LayerResponse>? = null, val odataType: String, val sceneChangeDetection: Boolean? = null, val stretchMode: String? = null, val syncMode: String? = null)

Describes all the properties for encoding a video with the H.265 codec.

Link copied to clipboard
data class HlsResponse(val fragmentsPerTsSegment: Int? = null)

HTTP Live Streaming (HLS) packing setting for the live output.

Link copied to clipboard
data class HlsSettingsResponse(val characteristics: String? = null, val default: Boolean? = null, val forced: Boolean? = null)

The HLS setting for a track.

Link copied to clipboard
data class ImageFormatResponse(val filenamePattern: String, val odataType: String)

Describes the properties for an output image file.

Link copied to clipboard
data class ImageResponse(val keyFrameInterval: String? = null, val label: String? = null, val odataType: String, val range: String? = null, val start: String, val step: String? = null, val stretchMode: String? = null, val syncMode: String? = null)

Describes the basic properties for generating thumbnails from the input video

Link copied to clipboard
data class InputFileResponse(val filename: String? = null, val includedTracks: List<Any>? = null, val odataType: String)

An InputDefinition for a single file. TrackSelections are scoped to the file specified.

Link copied to clipboard
data class IPAccessControlResponse(val allow: List<IPRangeResponse>? = null)

The IP access control.

Link copied to clipboard
data class IPRangeResponse(val address: String? = null, val name: String? = null, val subnetPrefixLength: Int? = null)

The IP address range in the CIDR scheme.

Link copied to clipboard
data class JobErrorDetailResponse(val code: String, val message: String)

Details of JobOutput errors.

Link copied to clipboard
data class JobErrorResponse(val category: String, val code: String, val details: List<JobErrorDetailResponse>, val message: String, val retry: String)

Details of JobOutput errors.

Link copied to clipboard
data class JobInputAssetResponse(val assetName: String, val end: Either<AbsoluteClipTimeResponse, UtcClipTimeResponse>? = null, val files: List<String>? = null, val inputDefinitions: List<Any>? = null, val label: String? = null, val odataType: String, val start: Either<AbsoluteClipTimeResponse, UtcClipTimeResponse>? = null)

Represents an Asset for input into a Job.

Link copied to clipboard
data class JobInputClipResponse(val end: Either<AbsoluteClipTimeResponse, UtcClipTimeResponse>? = null, val files: List<String>? = null, val inputDefinitions: List<Any>? = null, val label: String? = null, val odataType: String, val start: Either<AbsoluteClipTimeResponse, UtcClipTimeResponse>? = null)

Represents input files for a Job.

Link copied to clipboard
data class JobInputHttpResponse(val baseUri: String? = null, val end: Either<AbsoluteClipTimeResponse, UtcClipTimeResponse>? = null, val files: List<String>? = null, val inputDefinitions: List<Any>? = null, val label: String? = null, val odataType: String, val start: Either<AbsoluteClipTimeResponse, UtcClipTimeResponse>? = null)

Represents HTTPS job input.

Link copied to clipboard
data class JobInputSequenceResponse(val inputs: List<JobInputClipResponse>? = null, val odataType: String)

A Sequence contains an ordered list of Clips where each clip is a JobInput. The Sequence will be treated as a single input.

Link copied to clipboard
data class JobInputsResponse(val inputs: List<Any>? = null, val odataType: String)

Describes a list of inputs to a Job.

Link copied to clipboard
data class JobOutputAssetResponse(val assetName: String, val endTime: String, val error: JobErrorResponse, val label: String? = null, val odataType: String, val presetOverride: Any? = null, val progress: Int, val startTime: String, val state: String)

Represents an Asset used as a JobOutput.

Link copied to clipboard
data class JpgFormatResponse(val filenamePattern: String, val odataType: String)

Describes the settings for producing JPEG thumbnails.

Link copied to clipboard
data class JpgImageResponse(val keyFrameInterval: String? = null, val label: String? = null, val layers: List<JpgLayerResponse>? = null, val odataType: String, val range: String? = null, val spriteColumn: Int? = null, val start: String, val step: String? = null, val stretchMode: String? = null, val syncMode: String? = null)

Describes the properties for producing a series of JPEG images from the input video.

Link copied to clipboard
data class JpgLayerResponse(val height: String? = null, val label: String? = null, val quality: Int? = null, val width: String? = null)

Describes the settings to produce a JPEG image from the input video.

Link copied to clipboard
data class KeyDeliveryResponse(val accessControl: AccessControlResponse? = null)
Link copied to clipboard
data class KeyVaultPropertiesResponse(val currentKeyIdentifier: String, val keyIdentifier: String? = null)
Link copied to clipboard
data class ListAssetContainerSasResult(val assetContainerSasUrls: List<String>? = null)

The Asset Storage container SAS URLs.

Link copied to clipboard

The Streaming Locators associated with this Asset.

Link copied to clipboard
data class ListMediaServiceEdgePoliciesResult(val usageDataCollectionPolicy: EdgeUsageDataCollectionPolicyResponse? = null)
Link copied to clipboard
data class ListMediaServiceKeysResult(val primaryAuthEndpoint: String? = null, val primaryKey: String? = null, val scope: String? = null, val secondaryAuthEndpoint: String? = null, val secondaryKey: String? = null)

The response body for a ListKeys API.

Link copied to clipboard

Class of response for listContentKeys action

Link copied to clipboard
data class ListStreamingLocatorPathsResult(val downloadPaths: List<String>? = null, val streamingPaths: List<StreamingPathResponse>? = null)

Class of response for listPaths action

Link copied to clipboard
data class LiveEventEncodingResponse(val encodingType: String? = null, val keyFrameInterval: String? = null, val presetName: String? = null, val stretchMode: String? = null)

Specifies the live event type and optional encoding settings for encoding live events.

Link copied to clipboard
data class LiveEventEndpointResponse(val protocol: String? = null, val url: String? = null)

The live event endpoint.

Link copied to clipboard
data class LiveEventIngestInterruptionResponse(val begin: String? = null, val duration: String? = null, val end: String? = null, val reason: String? = null)

The live event ingest interruption data.

Link copied to clipboard
data class LiveEventIngestionResponse(val begin: String? = null, val end: String? = null, val endReason: String? = null, val ingestInterruptions: List<LiveEventIngestInterruptionResponse>? = null, val streamName: String? = null)

The live event ingestion telemetry data.

Link copied to clipboard

The IP access control for live event input.

Link copied to clipboard
data class LiveEventInputResponse(val accessControl: LiveEventInputAccessControlResponse? = null, val accessToken: String? = null, val endpoints: List<LiveEventEndpointResponse>? = null, val keyFrameIntervalDuration: String? = null, val streamingProtocol: String, val timedMetadataEndpoints: List<LiveEventTimedMetadataEndpointResponse>? = null)

The live event input.

Link copied to clipboard
data class LiveEventInputTrackSelectionResponse(val operation: String? = null, val property: String? = null, val value: String? = null)

A track selection condition. This property is reserved for future use, any value set on this property will be ignored.

Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored.

Link copied to clipboard

The IP access control for the live event preview endpoint.

Link copied to clipboard
data class LiveEventPreviewResponse(val accessControl: LiveEventPreviewAccessControlResponse? = null, val alternativeMediaId: String? = null, val endpoints: List<LiveEventEndpointResponse>? = null, val previewLocator: String? = null, val streamingPolicyName: String? = null)

Live event preview settings.

Link copied to clipboard
data class LiveEventStatusResponse(val healthDescriptions: List<String>? = null, val healthStatus: String? = null, val ingestion: LiveEventIngestionResponse? = null, val lastUpdatedTime: String? = null, val state: String? = null, val trackStatus: List<LiveEventTrackStatusResponse>? = null)

The live event status.

Link copied to clipboard
data class LiveEventStreamEventDataResponse(val bitrate: Double? = null, val currentFragmentTimestamp: String? = null, val discontinuityGap: Double? = null, val duration: String? = null, val fragmentDropReason: String? = null, val fragmentOneDuration: String? = null, val fragmentOneTimestamp: String? = null, val fragmentTwoDuration: String? = null, val fragmentTwoTimestamp: String? = null, val maxTime: String? = null, val maxTimeMediaType: String? = null, val mediaTimestamp: String? = null, val mediaType: String? = null, val minTime: String? = null, val minTimeMediaType: String? = null, val previousFragmentDuration: String? = null, val previousFragmentTimestamp: String? = null, val remoteIp: String? = null, val remotePort: String? = null, val resolution: String? = null, val resultCode: String? = null, val resultMessage: String? = null, val streamId: String? = null, val streamName: String? = null, val timescale: String? = null, val timescaleOfMaxTime: String? = null, val timescaleOfMinTime: String? = null, val trackId: Int? = null, val trackName: String? = null)

The live event stream event data.

Link copied to clipboard
data class LiveEventStreamEventResponse(val data: LiveEventStreamEventDataResponse? = null, val eventLevel: String? = null, val eventTime: String? = null, val eventType: String? = null)

The live event stream event.

Link copied to clipboard
data class LiveEventTimedMetadataEndpointResponse(val url: String? = null)

The live event metadata insertion endpoint.

Link copied to clipboard
data class LiveEventTrackEventDataResponse(val bitrate: Double? = null, val discontinuityCount: Double? = null, val healthy: Boolean? = null, val incomingBitrate: Double? = null, val ingestDriftValue: String? = null, val lastFragmentArrivalTime: String? = null, val lastTimestamp: String? = null, val nonincreasingCount: Double? = null, val overlapCount: Double? = null, val state: String? = null, val timescale: String? = null, val trackName: String? = null, val trackType: String? = null, val transcriptionLanguage: String? = null, val transcriptionState: String? = null, val unexpectedBitrate: Boolean? = null)

The live event track ingest heart beat event data.

Link copied to clipboard
data class LiveEventTrackEventResponse(val data: LiveEventTrackEventDataResponse? = null, val eventTime: String? = null, val eventType: String? = null)

The live event track event.

Link copied to clipboard
data class LiveEventTrackStatusResponse(val expectedBitrate: Double? = null, val incomingBitrate: Double? = null, val ingestDrift: String? = null, val requestReceived: Double? = null, val requestSucceeded: Double? = null, val trackId: String? = null)

The live event track status.

Link copied to clipboard
data class LiveEventTranscriptionResponse(val inputTrackSelection: List<LiveEventInputTrackSelectionResponse>? = null, val language: String? = null, val outputTranscriptionTrack: LiveEventOutputTranscriptionTrackResponse? = null)

Describes the transcription tracks in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored.

Link copied to clipboard
data class MediaGraphAssetSinkResponse(val assetName: String, val inputs: List<String>, val name: String, val odataType: String)

Asset sink.

Link copied to clipboard
data class MediaGraphClearEndpointResponse(val credentials: MediaGraphUsernamePasswordCredentialsResponse? = null, val odataType: String, val url: String)

An endpoint to connect to with no encryption in transit.

Link copied to clipboard
data class MediaGraphPemCertificateListResponse(val certificates: List<String>, val odataType: String)

A list of PEM formatted certificates.

Link copied to clipboard
data class MediaGraphRtspSourceResponse(val endpoint: Either<MediaGraphClearEndpointResponse, MediaGraphTlsEndpointResponse>, val name: String, val odataType: String, val transport: String)

RTSP source.

Link copied to clipboard
data class MediaGraphTlsEndpointResponse(val credentials: MediaGraphUsernamePasswordCredentialsResponse? = null, val odataType: String, val trustedCertificates: MediaGraphPemCertificateListResponse? = null, val url: String, val validationOptions: MediaGraphTlsValidationOptionsResponse? = null)

An endpoint which must be connected over TLS/SSL.

Link copied to clipboard
data class MediaGraphTlsValidationOptionsResponse(val ignoreHostname: Boolean, val ignoreSignature: Boolean)

Options for controlling the authentication of TLS endpoints.

data class MediaGraphUsernamePasswordCredentialsResponse(val odataType: String, val password: String, val username: String)

Username/password credential pair.

Link copied to clipboard
data class MediaServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedManagedIdentityResponse>? = null)
Link copied to clipboard
data class Mp4FormatResponse(val filenamePattern: String, val odataType: String, val outputFiles: List<OutputFileResponse>? = null)

Describes the properties for an output ISO MP4 file.

Link copied to clipboard
data class MultiBitrateFormatResponse(val filenamePattern: String, val odataType: String, val outputFiles: List<OutputFileResponse>? = null)

Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection.

Link copied to clipboard
data class NoEncryptionResponse(val enabledProtocols: EnabledProtocolsResponse? = null)

Class for NoEncryption scheme

Link copied to clipboard
data class OutputFileResponse(val labels: List<String>)

Represents an output file produced.

Link copied to clipboard
data class PngFormatResponse(val filenamePattern: String, val odataType: String)

Describes the settings for producing PNG thumbnails.

Link copied to clipboard
data class PngImageResponse(val keyFrameInterval: String? = null, val label: String? = null, val layers: List<PngLayerResponse>? = null, val odataType: String, val range: String? = null, val start: String, val step: String? = null, val stretchMode: String? = null, val syncMode: String? = null)

Describes the properties for producing a series of PNG images from the input video.

Link copied to clipboard
data class PngLayerResponse(val height: String? = null, val label: String? = null, val width: String? = null)

Describes the settings to produce a PNG image from the input video.

Link copied to clipboard
data class PresentationTimeRangeResponse(val endTimestamp: Double? = null, val forceEndTimestamp: Boolean? = null, val liveBackoffDuration: Double? = null, val presentationWindowDuration: Double? = null, val startTimestamp: Double? = null, val timescale: Double? = null)

The presentation time range, this is asset related and not recommended for Account Filter.

Link copied to clipboard
data class PresetConfigurationsResponse(val complexity: String? = null, val interleaveOutput: String? = null, val keyFrameIntervalInSeconds: Double? = null, val maxBitrateBps: Int? = null, val maxHeight: Int? = null, val maxLayers: Int? = null, val minBitrateBps: Int? = null, val minHeight: Int? = null)

An object of optional configuration settings for encoder.

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

A collection of information about the state of the connection between service consumer and provider.

Link copied to clipboard
data class RectangleResponse(val height: String? = null, val left: String? = null, val top: String? = null, val width: String? = null)

Describes the properties of a rectangular window applied to the input media before processing it.

Link copied to clipboard
data class ResourceIdentityResponse(val useSystemAssignedIdentity: Boolean, val userAssignedIdentity: String? = null)
Link copied to clipboard
data class SelectAudioTrackByAttributeResponse(val attribute: String, val channelMapping: String? = null, val filter: String, val filterValue: String? = null, val odataType: String)

Select audio tracks from the input by specifying an attribute and an attribute filter.

Link copied to clipboard
data class SelectAudioTrackByIdResponse(val channelMapping: String? = null, val odataType: String, val trackId: Double)

Select audio tracks from the input by specifying a track identifier.

Link copied to clipboard
data class SelectVideoTrackByAttributeResponse(val attribute: String, val filter: String, val filterValue: String? = null, val odataType: String)

Select video tracks from the input by specifying an attribute and an attribute filter.

Link copied to clipboard
data class SelectVideoTrackByIdResponse(val odataType: String, val trackId: Double)

Select video tracks from the input by specifying a track identifier.

Link copied to clipboard
data class StandardEncoderPresetResponse(val codecs: List<Any>, val experimentalOptions: Map<String, String>? = null, val filters: FiltersResponse? = null, val formats: List<Any>, val odataType: String)

Describes all the settings to be used when encoding the input video with the Standard Encoder.

Link copied to clipboard
data class StorageAccountResponse(val id: String? = null, val identity: ResourceIdentityResponse? = null, val status: String, val type: String)

The storage account details.

Link copied to clipboard

Streaming endpoint access control definition.

Link copied to clipboard
data class StreamingLocatorContentKeyResponse(val id: String, val labelReferenceInStreamingPolicy: String? = null, val policyName: String, val tracks: List<TrackSelectionResponse>, val type: String, val value: String? = null)

Class for content key in Streaming Locator

Link copied to clipboard
data class StreamingPathResponse(val encryptionScheme: String, val paths: List<String>? = null, val streamingProtocol: String)

Class of paths for streaming

Link copied to clipboard
data class StreamingPolicyContentKeyResponse(val label: String? = null, val policyName: String? = null, val tracks: List<TrackSelectionResponse>? = null)

Class to specify properties of content key

Link copied to clipboard
data class StreamingPolicyContentKeysResponse(val defaultKey: DefaultKeyResponse? = null, val keyToTrackMappings: List<StreamingPolicyContentKeyResponse>? = null)

Class to specify properties of all content keys in Streaming Policy

data class StreamingPolicyFairPlayConfigurationResponse(val allowPersistentLicense: Boolean, val customLicenseAcquisitionUrlTemplate: String? = null)

Class to specify configurations of FairPlay in Streaming Policy

data class StreamingPolicyPlayReadyConfigurationResponse(val customLicenseAcquisitionUrlTemplate: String? = null, val playReadyCustomAttributes: String? = null)

Class to specify configurations of PlayReady in Streaming Policy

data class StreamingPolicyWidevineConfigurationResponse(val customLicenseAcquisitionUrlTemplate: String? = null)

Class to specify configurations of Widevine in Streaming Policy

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TextTrackResponse(val displayName: String? = null, val fileName: String? = null, val hlsSettings: HlsSettingsResponse? = null, val languageCode: String, val odataType: String, val playerVisibility: String? = null)

Represents a text track in an asset. A text track is usually used for sparse data related to the audio or video tracks.

Link copied to clipboard
data class TrackPropertyConditionResponse(val operation: String, val property: String, val value: String? = null)

Class to specify one track property condition

Link copied to clipboard
data class TrackSelectionResponse(val trackSelections: List<TrackPropertyConditionResponse>? = null)

Class to select a track

Link copied to clipboard
data class TransformOutputResponse(val onError: String? = null, val preset: Any, val relativePriority: String? = null)

Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output.

Link copied to clipboard
data class TransportStreamFormatResponse(val filenamePattern: String, val odataType: String, val outputFiles: List<OutputFileResponse>? = null)

Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s).

Link copied to clipboard
data class UserAssignedManagedIdentityResponse(val clientId: String, val principalId: String)
Link copied to clipboard
data class UtcClipTimeResponse(val odataType: String, val time: String)

Specifies the clip time as a Utc time position in the media file. The Utc time can point to a different position depending on whether the media file starts from a timestamp of zero or not.

Link copied to clipboard
data class VideoAnalyzerPresetResponse(val audioLanguage: String? = null, val experimentalOptions: Map<String, String>? = null, val insightsToExtract: String? = null, val mode: String? = null, val odataType: String)

A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file.

Link copied to clipboard
data class VideoOverlayResponse(val audioGainLevel: Double? = null, val cropRectangle: RectangleResponse? = null, val end: String? = null, val fadeInDuration: String? = null, val fadeOutDuration: String? = null, val inputLabel: String, val odataType: String, val opacity: Double? = null, val position: RectangleResponse? = null, val start: String? = null)

Describes the properties of a video overlay.

Link copied to clipboard
data class VideoResponse(val keyFrameInterval: String? = null, val label: String? = null, val odataType: String, val stretchMode: String? = null, val syncMode: String? = null)

Describes the basic properties for encoding the input video.

Link copied to clipboard
data class VideoTrackDescriptorResponse(val odataType: String)

A TrackSelection to select video tracks.

Link copied to clipboard
data class VideoTrackResponse(val odataType: String)

Represents a video track in the asset.