diff --git a/README.md b/README.md index 986649baa..00e28d406 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ If you have any questions regarding the SDK, provided examples or our services, ## Installation ``` bash -npm install @bitmovin/api-sdk@1.195.0 +npm install @bitmovin/api-sdk@1.196.1 ``` ## Initialization diff --git a/docs/classes/AacAudioConfiguration.html b/docs/classes/AacAudioConfiguration.html index 57fbde700..7e53c981f 100644 --- a/docs/classes/AacAudioConfiguration.html +++ b/docs/classes/AacAudioConfiguration.html @@ -1,5 +1,5 @@ AacAudioConfiguration | @bitmovin/api-sdk

Class AacAudioConfiguration

Export

AacAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: AacChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: AacChannelLayout

Channel layout of the audio codec configuration

Memberof

AacAudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional cutoffFrequency

cutoffFrequency?: number

The highest frequency that will pass the audio encoder. This value is optional.

+

Optional cutoffFrequency

cutoffFrequency?: number

The highest frequency that will pass the audio encoder. This value is optional.

Memberof

AacAudioConfiguration

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.AAC

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.AAC

Discriminator property for CodecConfiguration

Memberof

AacAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatacutoffFrequencydescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatacutoffFrequencydescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AbstractCondition.html b/docs/classes/AbstractCondition.html index 2d703badf..33116589c 100644 --- a/docs/classes/AbstractCondition.html +++ b/docs/classes/AbstractCondition.html @@ -1,5 +1,5 @@ AbstractCondition | @bitmovin/api-sdk

Class AbstractCondition

Export

AbstractCondition

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

_discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructor_discriminatorMapping_discriminatorName
\ No newline at end of file +

Constructors

constructor

Properties

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructor_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AbstractConjunction.html b/docs/classes/AbstractConjunction.html index 30897ebad..e55de68c6 100644 --- a/docs/classes/AbstractConjunction.html +++ b/docs/classes/AbstractConjunction.html @@ -1,8 +1,8 @@ AbstractConjunction | @bitmovin/api-sdk

Class AbstractConjunction

Export

AbstractConjunction

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

conditions? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional conditions

conditions?: AbstractCondition[]

Array to perform the AND/OR evaluation on

+

Constructors

constructor

Properties

Optional conditions

conditions?: AbstractCondition[]

Array to perform the AND/OR evaluation on

Memberof

AbstractConjunction

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditions_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditions_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Ac3AudioConfiguration.html b/docs/classes/Ac3AudioConfiguration.html index 77f0bb01c..cad026461 100644 --- a/docs/classes/Ac3AudioConfiguration.html +++ b/docs/classes/Ac3AudioConfiguration.html @@ -1,5 +1,5 @@ Ac3AudioConfiguration | @bitmovin/api-sdk

Class Ac3AudioConfiguration

Export

Ac3AudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: Ac3ChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: Ac3ChannelLayout

Channel layout of the audio codec configuration

Memberof

Ac3AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional cutoffFrequency

cutoffFrequency?: number

The highest frequency that will pass the audio encoder. This value is optional.

+

Optional cutoffFrequency

cutoffFrequency?: number

The highest frequency that will pass the audio encoder. This value is optional.

Memberof

Ac3AudioConfiguration

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.AC3

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.AC3

Discriminator property for CodecConfiguration

Memberof

Ac3AudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatacutoffFrequencydescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatacutoffFrequencydescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Accessibility.html b/docs/classes/Accessibility.html index 0bb784f16..0ddd15383 100644 --- a/docs/classes/Accessibility.html +++ b/docs/classes/Accessibility.html @@ -1,9 +1,9 @@ Accessibility | @bitmovin/api-sdk

Class Accessibility

Export

Accessibility

-

Constructors

constructor +

Constructors

constructor

Properties

schemeIdUri? value? -

Constructors

constructor

Properties

Optional schemeIdUri

schemeIdUri?: string

The scheme id to use. Please refer to the DASH standard. (required)

+

Constructors

constructor

Properties

Optional schemeIdUri

schemeIdUri?: string

The scheme id to use. Please refer to the DASH standard. (required)

Memberof

Accessibility

-

Optional value

value?: string

Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology) (required)

+

Optional value

value?: string

Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology) (required)

Memberof

Accessibility

-

Settings

Member Visibility

Theme

On This Page

constructorschemeIdUrivalue
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorschemeIdUrivalue
\ No newline at end of file diff --git a/docs/classes/AccountApiKey.html b/docs/classes/AccountApiKey.html index a2151dc93..400bcac08 100644 --- a/docs/classes/AccountApiKey.html +++ b/docs/classes/AccountApiKey.html @@ -1,5 +1,5 @@ AccountApiKey | @bitmovin/api-sdk

Class AccountApiKey

Export

AccountApiKey

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -7,18 +7,18 @@ modifiedAt? name? value? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional value

value?: string

Key value for authentication with the Bitmovin API (required)

+

Optional value

value?: string

Key value for authentication with the Bitmovin API (required)

Memberof

AccountApiKey

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamevalue
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamevalue
\ No newline at end of file diff --git a/docs/classes/AccountInformation.html b/docs/classes/AccountInformation.html index a41bf08b2..5059d3502 100644 --- a/docs/classes/AccountInformation.html +++ b/docs/classes/AccountInformation.html @@ -1,5 +1,5 @@ AccountInformation | @bitmovin/api-sdk

Class AccountInformation

Export

AccountInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiKeys? company? createdAt? @@ -16,32 +16,32 @@ name? phone? verified? -

Constructors

constructor

Properties

Optional apiKeys

apiKeys?: AccountApiKey[]

ApiKeys associated with the account (required)

+

Constructors

constructor

Properties

Optional apiKeys

apiKeys?: AccountApiKey[]

ApiKeys associated with the account (required)

Memberof

AccountInformation

-

Optional company

company?: string

Company name of the tenant.

+

Optional company

company?: string

Company name of the tenant.

Memberof

AccountInformation

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional email

email?: string

Email address of the account. (required)

+

Optional email

email?: string

Email address of the account. (required)

Memberof

AccountInformation

-

Optional firstName

firstName?: string

First name of the tenant.

+

Optional firstName

firstName?: string

First name of the tenant.

Memberof

AccountInformation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional intercomIdVerification

intercomIdVerification?: string

Memberof

AccountInformation

-

Optional lastName

lastName?: string

Last name of the tenant.

+

Optional intercomIdVerification

intercomIdVerification?: string

Memberof

AccountInformation

+

Optional lastName

lastName?: string

Last name of the tenant.

Memberof

AccountInformation

-

Optional marketplace

marketplace?: Marketplace

Memberof

AccountInformation

-

Optional mfaEnabled

mfaEnabled?: boolean

Memberof

AccountInformation

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional marketplace

marketplace?: Marketplace

Memberof

AccountInformation

+

Optional mfaEnabled

mfaEnabled?: boolean

Memberof

AccountInformation

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional phone

phone?: string

Phone number of the tenant.

+

Optional phone

phone?: string

Phone number of the tenant.

Memberof

AccountInformation

-

Optional verified

verified?: boolean

Memberof

AccountInformation

-

Settings

Member Visibility

Theme

On This Page

constructorapiKeyscompanycreatedAtcustomDatadescriptionemailfirstNameidintercomIdVerificationlastNamemarketplacemfaEnabledmodifiedAtnamephoneverified
\ No newline at end of file +

Optional verified

verified?: boolean

Memberof

AccountInformation

+

Settings

Member Visibility

Theme

On This Page

constructorapiKeyscompanycreatedAtcustomDatadescriptionemailfirstNameidintercomIdVerificationlastNamemarketplacemfaEnabledmodifiedAtnamephoneverified
\ No newline at end of file diff --git a/docs/classes/Acl.html b/docs/classes/Acl.html index 81d7d5b36..ded2162c9 100644 --- a/docs/classes/Acl.html +++ b/docs/classes/Acl.html @@ -1,5 +1,5 @@ Acl | @bitmovin/api-sdk

Class Acl

Export

Acl

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,21 +9,21 @@ permissions? policy? resource? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional permissions

permissions?: Permission[]

Permissions to assign. (required)

+

Optional permissions

permissions?: Permission[]

Permissions to assign. (required)

Memberof

Acl

-

Optional policy

policy?: Policy

Memberof

Acl

-

Optional resource

resource?: string

Resource to define the permission for. (required)

+

Optional policy

policy?: Policy

Memberof

Acl

+

Optional resource

resource?: string

Resource to define the permission for. (required)

Memberof

Acl

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamepermissionspolicyresource
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamepermissionspolicyresource
\ No newline at end of file diff --git a/docs/classes/AclEntry.html b/docs/classes/AclEntry.html index 119ad5bab..935dd19cb 100644 --- a/docs/classes/AclEntry.html +++ b/docs/classes/AclEntry.html @@ -1,8 +1,8 @@ AclEntry | @bitmovin/api-sdk

Class AclEntry

Export

AclEntry

-

Constructors

constructor +

Constructors

constructor

Properties

permission? scope? -

Constructors

constructor

Properties

Optional permission

permission?: AclPermission

Memberof

AclEntry

-

Optional scope

scope?: string

Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all

+

Constructors

constructor

Properties

Optional permission

permission?: AclPermission

Memberof

AclEntry

+

Optional scope

scope?: string

Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all

Memberof

AclEntry

-

Settings

Member Visibility

Theme

On This Page

constructorpermissionscope
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpermissionscope
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsAbstractFilter.html b/docs/classes/AdAnalyticsAbstractFilter.html index 619875443..695547500 100644 --- a/docs/classes/AdAnalyticsAbstractFilter.html +++ b/docs/classes/AdAnalyticsAbstractFilter.html @@ -1,7 +1,7 @@ AdAnalyticsAbstractFilter | @bitmovin/api-sdk

Class AdAnalyticsAbstractFilter

Export

AdAnalyticsAbstractFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructorname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructorname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsAvgQueryRequest.html b/docs/classes/AdAnalyticsAvgQueryRequest.html index fa4ced3b0..97a0d71fc 100644 --- a/docs/classes/AdAnalyticsAvgQueryRequest.html +++ b/docs/classes/AdAnalyticsAvgQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsAvgQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsAvgQueryRequest

Export

AdAnalyticsAvgQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsContainsFilter.html b/docs/classes/AdAnalyticsContainsFilter.html index 0cc91ac0b..115cbfc62 100644 --- a/docs/classes/AdAnalyticsContainsFilter.html +++ b/docs/classes/AdAnalyticsContainsFilter.html @@ -1,12 +1,12 @@ AdAnalyticsContainsFilter | @bitmovin/api-sdk

Class AdAnalyticsContainsFilter

Export

AdAnalyticsContainsFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.CONTAINS

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.CONTAINS

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsContainsFilter

-

Optional value

value?: any

Memberof

AdAnalyticsContainsFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AdAnalyticsContainsFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsCountQueryRequest.html b/docs/classes/AdAnalyticsCountQueryRequest.html index 2c3461298..98dc55a9a 100644 --- a/docs/classes/AdAnalyticsCountQueryRequest.html +++ b/docs/classes/AdAnalyticsCountQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsCountQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsCountQueryRequest

Export

AdAnalyticsCountQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsEqualFilter.html b/docs/classes/AdAnalyticsEqualFilter.html index a615090d5..9e1888820 100644 --- a/docs/classes/AdAnalyticsEqualFilter.html +++ b/docs/classes/AdAnalyticsEqualFilter.html @@ -1,12 +1,12 @@ AdAnalyticsEqualFilter | @bitmovin/api-sdk

Class AdAnalyticsEqualFilter

Export

AdAnalyticsEqualFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.EQ

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.EQ

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsEqualFilter

-

Optional value

value?: any

Memberof

AdAnalyticsEqualFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AdAnalyticsEqualFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsGreaterThanFilter.html b/docs/classes/AdAnalyticsGreaterThanFilter.html index 8010ff5f9..32f501861 100644 --- a/docs/classes/AdAnalyticsGreaterThanFilter.html +++ b/docs/classes/AdAnalyticsGreaterThanFilter.html @@ -1,12 +1,12 @@ AdAnalyticsGreaterThanFilter | @bitmovin/api-sdk

Class AdAnalyticsGreaterThanFilter

Export

AdAnalyticsGreaterThanFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.GT

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.GT

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsGreaterThanFilter

-

Optional value

value?: any

Memberof

AdAnalyticsGreaterThanFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AdAnalyticsGreaterThanFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsGreaterThanOrEqualFilter.html b/docs/classes/AdAnalyticsGreaterThanOrEqualFilter.html index 6326bdc04..74b012fb5 100644 --- a/docs/classes/AdAnalyticsGreaterThanOrEqualFilter.html +++ b/docs/classes/AdAnalyticsGreaterThanOrEqualFilter.html @@ -1,12 +1,12 @@ AdAnalyticsGreaterThanOrEqualFilter | @bitmovin/api-sdk

Class AdAnalyticsGreaterThanOrEqualFilter

Export

AdAnalyticsGreaterThanOrEqualFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.GTE

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.GTE

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsGreaterThanOrEqualFilter

-

Optional value

value?: any

Memberof

AdAnalyticsGreaterThanOrEqualFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AdAnalyticsGreaterThanOrEqualFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsInFilter.html b/docs/classes/AdAnalyticsInFilter.html index 832d4b972..8521b9e11 100644 --- a/docs/classes/AdAnalyticsInFilter.html +++ b/docs/classes/AdAnalyticsInFilter.html @@ -1,12 +1,12 @@ AdAnalyticsInFilter | @bitmovin/api-sdk

Class AdAnalyticsInFilter

Export

AdAnalyticsInFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.IN

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.IN

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsInFilter

-

Optional value

value?: any[]

Memberof

AdAnalyticsInFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any[]

Memberof

AdAnalyticsInFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsLessThanFilter.html b/docs/classes/AdAnalyticsLessThanFilter.html index f76232701..1fb16232f 100644 --- a/docs/classes/AdAnalyticsLessThanFilter.html +++ b/docs/classes/AdAnalyticsLessThanFilter.html @@ -1,12 +1,12 @@ AdAnalyticsLessThanFilter | @bitmovin/api-sdk

Class AdAnalyticsLessThanFilter

Export

AdAnalyticsLessThanFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.LT

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.LT

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsLessThanFilter

-

Optional value

value?: any

Memberof

AdAnalyticsLessThanFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AdAnalyticsLessThanFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsLessThanOrEqualFilter.html b/docs/classes/AdAnalyticsLessThanOrEqualFilter.html index b4e7a523c..8f3238108 100644 --- a/docs/classes/AdAnalyticsLessThanOrEqualFilter.html +++ b/docs/classes/AdAnalyticsLessThanOrEqualFilter.html @@ -1,12 +1,12 @@ AdAnalyticsLessThanOrEqualFilter | @bitmovin/api-sdk

Class AdAnalyticsLessThanOrEqualFilter

Export

AdAnalyticsLessThanOrEqualFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.LTE

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.LTE

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsLessThanOrEqualFilter

-

Optional value

value?: any

Memberof

AdAnalyticsLessThanOrEqualFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AdAnalyticsLessThanOrEqualFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsMaxQueryRequest.html b/docs/classes/AdAnalyticsMaxQueryRequest.html index 4af9aed5a..ba3462cf0 100644 --- a/docs/classes/AdAnalyticsMaxQueryRequest.html +++ b/docs/classes/AdAnalyticsMaxQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsMaxQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsMaxQueryRequest

Export

AdAnalyticsMaxQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsMedianQueryRequest.html b/docs/classes/AdAnalyticsMedianQueryRequest.html index 6894e33d6..d8b98ce6a 100644 --- a/docs/classes/AdAnalyticsMedianQueryRequest.html +++ b/docs/classes/AdAnalyticsMedianQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsMedianQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsMedianQueryRequest

Export

AdAnalyticsMedianQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsMinQueryRequest.html b/docs/classes/AdAnalyticsMinQueryRequest.html index 00d75153e..41f3039c1 100644 --- a/docs/classes/AdAnalyticsMinQueryRequest.html +++ b/docs/classes/AdAnalyticsMinQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsMinQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsMinQueryRequest

Export

AdAnalyticsMinQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsNotContainsFilter.html b/docs/classes/AdAnalyticsNotContainsFilter.html index 9d5d5656b..40e504db5 100644 --- a/docs/classes/AdAnalyticsNotContainsFilter.html +++ b/docs/classes/AdAnalyticsNotContainsFilter.html @@ -1,12 +1,12 @@ AdAnalyticsNotContainsFilter | @bitmovin/api-sdk

Class AdAnalyticsNotContainsFilter

Export

AdAnalyticsNotContainsFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.NOTCONTAINS

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.NOTCONTAINS

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsNotContainsFilter

-

Optional value

value?: any

Memberof

AdAnalyticsNotContainsFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AdAnalyticsNotContainsFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsNotEqualFilter.html b/docs/classes/AdAnalyticsNotEqualFilter.html index 2171bfd0d..90991d309 100644 --- a/docs/classes/AdAnalyticsNotEqualFilter.html +++ b/docs/classes/AdAnalyticsNotEqualFilter.html @@ -1,12 +1,12 @@ AdAnalyticsNotEqualFilter | @bitmovin/api-sdk

Class AdAnalyticsNotEqualFilter

Export

AdAnalyticsNotEqualFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.NE

Discriminator property for AdAnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.NE

Discriminator property for AdAnalyticsAbstractFilter

Memberof

AdAnalyticsNotEqualFilter

-

Optional value

value?: any

Memberof

AdAnalyticsNotEqualFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AdAnalyticsNotEqualFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsOrderByEntry.html b/docs/classes/AdAnalyticsOrderByEntry.html index c62a1d467..82afe21da 100644 --- a/docs/classes/AdAnalyticsOrderByEntry.html +++ b/docs/classes/AdAnalyticsOrderByEntry.html @@ -1,7 +1,7 @@ AdAnalyticsOrderByEntry | @bitmovin/api-sdk

Class AdAnalyticsOrderByEntry

Export

AdAnalyticsOrderByEntry

-

Constructors

constructor +

Constructors

constructor

Properties

name? order? -

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsOrderByEntry

-

Optional order

order?: AnalyticsOrder

Memberof

AdAnalyticsOrderByEntry

-

Settings

Member Visibility

Theme

On This Page

constructornameorder
\ No newline at end of file +

Constructors

constructor

Properties

Optional name

name?: AdAnalyticsAttribute

Memberof

AdAnalyticsOrderByEntry

+

Optional order

order?: AnalyticsOrder

Memberof

AdAnalyticsOrderByEntry

+

Settings

Member Visibility

Theme

On This Page

constructornameorder
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsPercentileQueryRequest.html b/docs/classes/AdAnalyticsPercentileQueryRequest.html index 9eb5016f7..1caa0ea81 100644 --- a/docs/classes/AdAnalyticsPercentileQueryRequest.html +++ b/docs/classes/AdAnalyticsPercentileQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsPercentileQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsPercentileQueryRequest

Export

AdAnalyticsPercentileQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ orderBy? percentile? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional percentile

percentile?: number

The percentage (0-99) used for percentile queries. (required)

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional percentile

percentile?: number

The percentage (0-99) used for percentile queries. (required)

Memberof

AdAnalyticsPercentileQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBypercentilestart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBypercentilestart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsQueryRequest.html b/docs/classes/AdAnalyticsQueryRequest.html index ef0d1278d..74a4f4dec 100644 --- a/docs/classes/AdAnalyticsQueryRequest.html +++ b/docs/classes/AdAnalyticsQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsQueryRequest

Export

AdAnalyticsQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsStddevQueryRequest.html b/docs/classes/AdAnalyticsStddevQueryRequest.html index 250a6c0d3..e98c344c3 100644 --- a/docs/classes/AdAnalyticsStddevQueryRequest.html +++ b/docs/classes/AdAnalyticsStddevQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsStddevQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsStddevQueryRequest

Export

AdAnalyticsStddevQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsSumQueryRequest.html b/docs/classes/AdAnalyticsSumQueryRequest.html index 82a8416ae..b9d2b4eeb 100644 --- a/docs/classes/AdAnalyticsSumQueryRequest.html +++ b/docs/classes/AdAnalyticsSumQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsSumQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsSumQueryRequest

Export

AdAnalyticsSumQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdAnalyticsVarianceQueryRequest.html b/docs/classes/AdAnalyticsVarianceQueryRequest.html index bbce7c31f..c6092a8e0 100644 --- a/docs/classes/AdAnalyticsVarianceQueryRequest.html +++ b/docs/classes/AdAnalyticsVarianceQueryRequest.html @@ -1,5 +1,5 @@ AdAnalyticsVarianceQueryRequest | @bitmovin/api-sdk

Class AdAnalyticsVarianceQueryRequest

Export

AdAnalyticsVarianceQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -10,20 +10,20 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AdAnalyticsAttribute

Memberof

AdAnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AdAnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AdAnalyticsQueryRequest

-

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional groupBy

groupBy?: AdAnalyticsAttribute[]

Memberof

AdAnalyticsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AdAnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AdAnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AdAnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AdAnalyticsQueryRequest

-

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AdAnalyticsOrderByEntry[]

Memberof

AdAnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AdaptationSet.html b/docs/classes/AdaptationSet.html index 86766fe43..04956550d 100644 --- a/docs/classes/AdaptationSet.html +++ b/docs/classes/AdaptationSet.html @@ -1,5 +1,5 @@ AdaptationSet | @bitmovin/api-sdk

Class AdaptationSet

Export

AdaptationSet

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessibilities? customAttributes? id? @@ -7,14 +7,14 @@ roles? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

+

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

Memberof

AdaptationSet

-

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

+

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

Memberof

AdaptationSet

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional labels

labels?: Label[]

List of labels

+

Optional labels

labels?: Label[]

List of labels

Memberof

AdaptationSet

-

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

+

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

Memberof

AdaptationSet

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

  • AUDIO: string
  • IMAGE: string
  • SUBTITLE: string
  • VIDEO: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelsroles_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelsroles_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AdaptationSetTypeResponse.html b/docs/classes/AdaptationSetTypeResponse.html index 1a323ff0d..3c53a38ce 100644 --- a/docs/classes/AdaptationSetTypeResponse.html +++ b/docs/classes/AdaptationSetTypeResponse.html @@ -1,6 +1,6 @@ AdaptationSetTypeResponse | @bitmovin/api-sdk

Class AdaptationSetTypeResponse

Export

AdaptationSetTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: AdaptationSetType

The type of the adaptation set

+

Constructors

constructor

Properties

Optional type

type?: AdaptationSetType

The type of the adaptation set

Memberof

AdaptationSetTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/AesEncryptionDrm.html b/docs/classes/AesEncryptionDrm.html index 0ff0787c4..43eeba853 100644 --- a/docs/classes/AesEncryptionDrm.html +++ b/docs/classes/AesEncryptionDrm.html @@ -1,5 +1,5 @@ AesEncryptionDrm | @bitmovin/api-sdk

Class AesEncryptionDrm

Export

AesEncryptionDrm

-

Hierarchy (view full)

  • Drm
    • AesEncryptionDrm

Constructors

constructor +

Hierarchy (view full)

  • Drm
    • AesEncryptionDrm

Constructors

constructor

Properties

createdAt? customData? description? @@ -14,26 +14,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional iv

iv?: string

16 byte initialization vector

+

Optional iv

iv?: string

16 byte initialization vector

Memberof

AesEncryptionDrm

-

Optional key

key?: string

16 byte Encryption key, 32 hexadecimal characters (required)

+

Optional key

key?: string

16 byte Encryption key, 32 hexadecimal characters (required)

Memberof

AesEncryptionDrm

-

Optional keyFileUri

keyFileUri?: string

Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.

+

Optional keyFileUri

keyFileUri?: string

Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.

Memberof

AesEncryptionDrm

-

Optional method

method?: AesEncryptionMethod

Memberof

AesEncryptionDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional method

method?: AesEncryptionMethod

Memberof

AesEncryptionDrm

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Readonly type

type: DrmType = DrmType.AES

Discriminator property for Drm

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Readonly type

type: DrmType = DrmType.AES

Discriminator property for Drm

Memberof

AesEncryptionDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidivkeykeyFileUrimethodmodifiedAtnameoutputstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidivkeykeyFileUrimethodmodifiedAtnameoutputstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AkamaiMslOutput.html b/docs/classes/AkamaiMslOutput.html index 7ee257d48..2d0079660 100644 --- a/docs/classes/AkamaiMslOutput.html +++ b/docs/classes/AkamaiMslOutput.html @@ -1,5 +1,5 @@ AkamaiMslOutput | @bitmovin/api-sdk

Class AkamaiMslOutput

Export

AkamaiMslOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -14,30 +14,30 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional eventName

eventName?: string

The Akamai event name (required)

+

Optional eventName

eventName?: string

The Akamai event name (required)

Memberof

AkamaiMslOutput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional mslVersion

mslVersion?: MSL4

The Akamai MSL Version. Only MSL4 is supported at the moment. (required)

+

Optional mslVersion

mslVersion?: MSL4

The Akamai MSL Version. Only MSL4 is supported at the moment. (required)

Memberof

AkamaiMslOutput

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional streamFormat

streamFormat?: AkamaiMslStreamFormat
    +

Optional streamFormat

streamFormat?: AkamaiMslStreamFormat
  • DASH: configure the Encoding with fMP4 or CMAF muxings and a DASH manifest. - HLS: configure the Encoding with TS muxings and an HLS manifest. - CMAF: configure the Encoding with fMP4 or CMAF muxings with both DASH and HLS manifests. (required)

Memberof

AkamaiMslOutput

-

Optional streamId

streamId?: number

The Akamai stream ID (required)

+

Optional streamId

streamId?: number

The Akamai stream ID (required)

Memberof

AkamaiMslOutput

-

Readonly type

type: OutputType = OutputType.AKAMAI_MSL

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.AKAMAI_MSL

Discriminator property for Output

Memberof

AkamaiMslOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptioneventNameidmodifiedAtmslVersionnamestreamFormatstreamIdtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptioneventNameidmodifiedAtmslVersionnamestreamFormatstreamIdtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AkamaiNetStorageInput.html b/docs/classes/AkamaiNetStorageInput.html index 9c8674258..dacdce8dd 100644 --- a/docs/classes/AkamaiNetStorageInput.html +++ b/docs/classes/AkamaiNetStorageInput.html @@ -1,5 +1,5 @@ AkamaiNetStorageInput | @bitmovin/api-sdk

Class AkamaiNetStorageInput

Export

AkamaiNetStorageInput

-

Hierarchy (view full)

  • Input
    • AkamaiNetStorageInput

Constructors

constructor +

Hierarchy (view full)

  • Input
    • AkamaiNetStorageInput

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,24 +12,24 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Host to use for Akamai NetStorage transfers (required)

+

Optional host

host?: string

Host to use for Akamai NetStorage transfers (required)

Memberof

AkamaiNetStorageInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional password

password?: string

Your Akamai NetStorage password (required)

+

Optional password

password?: string

Your Akamai NetStorage password (required)

Memberof

AkamaiNetStorageInput

-

Readonly type

type: InputType = InputType.AKAMAI_NETSTORAGE

Discriminator property for Input

+

Readonly type

type: InputType = InputType.AKAMAI_NETSTORAGE

Discriminator property for Input

Memberof

AkamaiNetStorageInput

-

Optional username

username?: string

Your Akamai NetStorage Username (required)

+

Optional username

username?: string

Your Akamai NetStorage Username (required)

Memberof

AkamaiNetStorageInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepasswordtypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepasswordtypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AkamaiNetStorageOutput.html b/docs/classes/AkamaiNetStorageOutput.html index 0bb0cb2b4..930dd2b6c 100644 --- a/docs/classes/AkamaiNetStorageOutput.html +++ b/docs/classes/AkamaiNetStorageOutput.html @@ -1,5 +1,5 @@ AkamaiNetStorageOutput | @bitmovin/api-sdk

Class AkamaiNetStorageOutput

Export

AkamaiNetStorageOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -13,26 +13,26 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Host to use for Akamai NetStorage transfers (required)

+

Optional host

host?: string

Host to use for Akamai NetStorage transfers (required)

Memberof

AkamaiNetStorageOutput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional password

password?: string

Your Akamai NetStorage password (required)

+

Optional password

password?: string

Your Akamai NetStorage password (required)

Memberof

AkamaiNetStorageOutput

-

Readonly type

type: OutputType = OutputType.AKAMAI_NETSTORAGE

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.AKAMAI_NETSTORAGE

Discriminator property for Output

Memberof

AkamaiNetStorageOutput

-

Optional username

username?: string

Your Akamai NetStorage Username (required)

+

Optional username

username?: string

Your Akamai NetStorage Username (required)

Memberof

AkamaiNetStorageOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionhostidmodifiedAtnamepasswordtypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionhostidmodifiedAtnamepasswordtypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsAbstractFilter.html b/docs/classes/AnalyticsAbstractFilter.html index ee9ead4fd..f35a33747 100644 --- a/docs/classes/AnalyticsAbstractFilter.html +++ b/docs/classes/AnalyticsAbstractFilter.html @@ -1,7 +1,7 @@ AnalyticsAbstractFilter | @bitmovin/api-sdk

Class AnalyticsAbstractFilter

Export

AnalyticsAbstractFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructorname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructorname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsAdsImpressionSample.html b/docs/classes/AnalyticsAdsImpressionSample.html index 15dc67cef..24ea26275 100644 --- a/docs/classes/AnalyticsAdsImpressionSample.html +++ b/docs/classes/AnalyticsAdsImpressionSample.html @@ -1,5 +1,5 @@ AnalyticsAdsImpressionSample | @bitmovin/api-sdk

Class AnalyticsAdsImpressionSample

Export

AnalyticsAdsImpressionSample

-

Constructors

constructor +

Constructors

constructor

Properties

adClickthroughUrl? adDescription? adDuration? @@ -143,290 +143,290 @@ videoTitle? videoWindowHeight? videoWindowWidth? -

Constructors

constructor

Properties

Optional adClickthroughUrl

adClickthroughUrl?: string

Ad click through url

+

Constructors

constructor

Properties

Optional adClickthroughUrl

adClickthroughUrl?: string

Ad click through url

Memberof

AnalyticsAdsImpressionSample

-

Optional adDescription

adDescription?: string

Ad description

+

Optional adDescription

adDescription?: string

Ad description

Memberof

AnalyticsAdsImpressionSample

-

Optional adDuration

adDuration?: number

Ad duration

+

Optional adDuration

adDuration?: number

Ad duration

Memberof

AnalyticsAdsImpressionSample

-

Optional adFallbackIndex

adFallbackIndex?: number

Ad fallback index

+

Optional adFallbackIndex

adFallbackIndex?: number

Ad fallback index

Memberof

AnalyticsAdsImpressionSample

-

Optional adId

adId?: string

Ad id

+

Optional adId

adId?: string

Ad id

Memberof

AnalyticsAdsImpressionSample

-

Optional adIdPlayer

adIdPlayer?: string

Ad id player

+

Optional adIdPlayer

adIdPlayer?: string

Ad id player

Memberof

AnalyticsAdsImpressionSample

-

Optional adImpressionId

adImpressionId?: string

Ad impression id

+

Optional adImpressionId

adImpressionId?: string

Ad impression id

Memberof

AnalyticsAdsImpressionSample

-

Optional adIsPersistent

adIsPersistent?: boolean

Ad is persistent

+

Optional adIsPersistent

adIsPersistent?: boolean

Ad is persistent

Memberof

AnalyticsAdsImpressionSample

-

Optional adModule

adModule?: string

Ad module

+

Optional adModule

adModule?: string

Ad module

Memberof

AnalyticsAdsImpressionSample

-

Optional adModuleVersion

adModuleVersion?: string

Ad module version

+

Optional adModuleVersion

adModuleVersion?: string

Ad module version

Memberof

AnalyticsAdsImpressionSample

-

Optional adOffset

adOffset?: string

Ad offset

+

Optional adOffset

adOffset?: string

Ad offset

Memberof

AnalyticsAdsImpressionSample

-

Optional adPlaybackHeight

adPlaybackHeight?: number

Ad playback height

+

Optional adPlaybackHeight

adPlaybackHeight?: number

Ad playback height

Memberof

AnalyticsAdsImpressionSample

-

Optional adPlaybackWidth

adPlaybackWidth?: number

Ad playback width

+

Optional adPlaybackWidth

adPlaybackWidth?: number

Ad playback width

Memberof

AnalyticsAdsImpressionSample

-

Optional adPodPosition

adPodPosition?: number

Ad pod position

+

Optional adPodPosition

adPodPosition?: number

Ad pod position

Memberof

AnalyticsAdsImpressionSample

-

Optional adPosition

adPosition?: string

Ad position

+

Optional adPosition

adPosition?: string

Ad position

Memberof

AnalyticsAdsImpressionSample

-

Optional adPreloadOffset

adPreloadOffset?: number

Ad preload offset

+

Optional adPreloadOffset

adPreloadOffset?: number

Ad preload offset

Memberof

AnalyticsAdsImpressionSample

-

Optional adReplaceContentDuration

adReplaceContentDuration?: number

Ad replace content duration

+

Optional adReplaceContentDuration

adReplaceContentDuration?: number

Ad replace content duration

Memberof

AnalyticsAdsImpressionSample

-

Optional adScheduleTime

adScheduleTime?: number

Ad schedule duration

+

Optional adScheduleTime

adScheduleTime?: number

Ad schedule duration

Memberof

AnalyticsAdsImpressionSample

-

Optional adSkipAfter

adSkipAfter?: number

Ad skip after

+

Optional adSkipAfter

adSkipAfter?: number

Ad skip after

Memberof

AnalyticsAdsImpressionSample

-

Optional adSkippable

adSkippable?: boolean

Ad is skippable

+

Optional adSkippable

adSkippable?: boolean

Ad is skippable

Memberof

AnalyticsAdsImpressionSample

-

Optional adStartupTime

adStartupTime?: number

Ad startup time

+

Optional adStartupTime

adStartupTime?: number

Ad startup time

Memberof

AnalyticsAdsImpressionSample

-

Optional adSystem

adSystem?: string

Ad system

+

Optional adSystem

adSystem?: string

Ad system

Memberof

AnalyticsAdsImpressionSample

-

Optional adTagPath

adTagPath?: string

Ad tag path

+

Optional adTagPath

adTagPath?: string

Ad tag path

Memberof

AnalyticsAdsImpressionSample

-

Optional adTagServer

adTagServer?: string

Ad system

+

Optional adTagServer

adTagServer?: string

Ad system

Memberof

AnalyticsAdsImpressionSample

-

Optional adTagType

adTagType?: string

Ad tag type

+

Optional adTagType

adTagType?: string

Ad tag type

Memberof

AnalyticsAdsImpressionSample

-

Optional adTagUrl

adTagUrl?: string

Ad tag url

+

Optional adTagUrl

adTagUrl?: string

Ad tag url

Memberof

AnalyticsAdsImpressionSample

-

Optional adTitle

adTitle?: string

Ad title

+

Optional adTitle

adTitle?: string

Ad title

Memberof

AnalyticsAdsImpressionSample

-

Optional adWrapperAdsCount

adWrapperAdsCount?: number

Ad wrapper ads count

+

Optional adWrapperAdsCount

adWrapperAdsCount?: number

Ad wrapper ads count

Memberof

AnalyticsAdsImpressionSample

-

Optional advertiserName

advertiserName?: string

Advertiser name

+

Optional advertiserName

advertiserName?: string

Advertiser name

Memberof

AnalyticsAdsImpressionSample

-

Optional analyticsVersion

analyticsVersion?: string

Analytics version

+

Optional analyticsVersion

analyticsVersion?: string

Analytics version

Memberof

AnalyticsAdsImpressionSample

-

Optional apiFramework

apiFramework?: string

Api framework

+

Optional apiFramework

apiFramework?: string

Api framework

Memberof

AnalyticsAdsImpressionSample

-

Optional apiorgId

apiorgId?: string

Organization id

+

Optional apiorgId

apiorgId?: string

Organization id

Memberof

AnalyticsAdsImpressionSample

-

Optional apiuserId

apiuserId?: string

User id

+

Optional apiuserId

apiuserId?: string

User id

Memberof

AnalyticsAdsImpressionSample

-

Optional audioBitrate

audioBitrate?: number

Audio bitrate

+

Optional audioBitrate

audioBitrate?: number

Audio bitrate

Memberof

AnalyticsAdsImpressionSample

-

Optional autoplay

autoplay?: boolean

Is autoplay

+

Optional autoplay

autoplay?: boolean

Is autoplay

Memberof

AnalyticsAdsImpressionSample

-

Optional browser

browser?: string

Browser name

+

Optional browser

browser?: string

Browser name

Memberof

AnalyticsAdsImpressionSample

-

Optional browserIsBot

browserIsBot?: boolean

Browser is bot

+

Optional browserIsBot

browserIsBot?: boolean

Browser is bot

Memberof

AnalyticsAdsImpressionSample

-

Optional browserVersionMajor

browserVersionMajor?: string

Browser version major

+

Optional browserVersionMajor

browserVersionMajor?: string

Browser version major

Memberof

AnalyticsAdsImpressionSample

-

Optional browserVersionMinor

browserVersionMinor?: string

Browser version minor

+

Optional browserVersionMinor

browserVersionMinor?: string

Browser version minor

Memberof

AnalyticsAdsImpressionSample

-

Optional cdnProvider

cdnProvider?: string

CDN Provider

+

Optional cdnProvider

cdnProvider?: string

CDN Provider

Memberof

AnalyticsAdsImpressionSample

-

Optional city

city?: string

City

+

Optional city

city?: string

City

Memberof

AnalyticsAdsImpressionSample

-

Optional clickPercentage

clickPercentage?: number

Click percentage

+

Optional clickPercentage

clickPercentage?: number

Click percentage

Memberof

AnalyticsAdsImpressionSample

-

Optional clickPosition

clickPosition?: number

Click position

+

Optional clickPosition

clickPosition?: number

Click position

Memberof

AnalyticsAdsImpressionSample

-

Optional clicked

clicked?: number

Clicked

+

Optional clicked

clicked?: number

Clicked

Memberof

AnalyticsAdsImpressionSample

-

Optional clientTime

clientTime?: number

Current time of the client

+

Optional clientTime

clientTime?: number

Current time of the client

Memberof

AnalyticsAdsImpressionSample

-

Optional closePercentage

closePercentage?: number

Close percentage

+

Optional closePercentage

closePercentage?: number

Close percentage

Memberof

AnalyticsAdsImpressionSample

-

Optional closePosition

closePosition?: number

Close position

+

Optional closePosition

closePosition?: number

Close position

Memberof

AnalyticsAdsImpressionSample

-

Optional closed

closed?: number

Closed

+

Optional closed

closed?: number

Closed

Memberof

AnalyticsAdsImpressionSample

-

Optional completed

completed?: number

Completed

+

Optional completed

completed?: number

Completed

Memberof

AnalyticsAdsImpressionSample

-

Optional country

country?: string

Country

+

Optional country

country?: string

Country

Memberof

AnalyticsAdsImpressionSample

-

Optional creativeAdId

creativeAdId?: string

Creative ad id

+

Optional creativeAdId

creativeAdId?: string

Creative ad id

Memberof

AnalyticsAdsImpressionSample

-

Optional creativeId

creativeId?: string

Creative id

+

Optional creativeId

creativeId?: string

Creative id

Memberof

AnalyticsAdsImpressionSample

-

Optional customData1

customData1?: string

Free form data set via the customData1 field in the analytics collector configuration

+

Optional customData1

customData1?: string

Free form data set via the customData1 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData10

customData10?: string

Free form data set via the customData10 field in the analytics collector configuration

+

Optional customData10

customData10?: string

Free form data set via the customData10 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData11

customData11?: string

Free form data set via the customData11 field in the analytics collector configuration

+

Optional customData11

customData11?: string

Free form data set via the customData11 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData12

customData12?: string

Free form data set via the customData12 field in the analytics collector configuration

+

Optional customData12

customData12?: string

Free form data set via the customData12 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData13

customData13?: string

Free form data set via the customData13 field in the analytics collector configuration

+

Optional customData13

customData13?: string

Free form data set via the customData13 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData14

customData14?: string

Free form data set via the customData14 field in the analytics collector configuration

+

Optional customData14

customData14?: string

Free form data set via the customData14 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData15

customData15?: string

Free form data set via the customData15 field in the analytics collector configuration

+

Optional customData15

customData15?: string

Free form data set via the customData15 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData16

customData16?: string

Free form data set via the customData16 field in the analytics collector configuration

+

Optional customData16

customData16?: string

Free form data set via the customData16 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData17

customData17?: string

Free form data set via the customData17 field in the analytics collector configuration

+

Optional customData17

customData17?: string

Free form data set via the customData17 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData18

customData18?: string

Free form data set via the customData18 field in the analytics collector configuration

+

Optional customData18

customData18?: string

Free form data set via the customData18 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData19

customData19?: string

Free form data set via the customData19 field in the analytics collector configuration

+

Optional customData19

customData19?: string

Free form data set via the customData19 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData2

customData2?: string

Free form data set via the customData2 field in the analytics collector configuration

+

Optional customData2

customData2?: string

Free form data set via the customData2 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData20

customData20?: string

Free form data set via the customData20 field in the analytics collector configuration

+

Optional customData20

customData20?: string

Free form data set via the customData20 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData21

customData21?: string

Free form data set via the customData21 field in the analytics collector configuration

+

Optional customData21

customData21?: string

Free form data set via the customData21 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData22

customData22?: string

Free form data set via the customData22 field in the analytics collector configuration

+

Optional customData22

customData22?: string

Free form data set via the customData22 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData23

customData23?: string

Free form data set via the customData23 field in the analytics collector configuration

+

Optional customData23

customData23?: string

Free form data set via the customData23 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData24

customData24?: string

Free form data set via the customData24 field in the analytics collector configuration

+

Optional customData24

customData24?: string

Free form data set via the customData24 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData25

customData25?: string

Free form data set via the customData25 field in the analytics collector configuration

+

Optional customData25

customData25?: string

Free form data set via the customData25 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData26

customData26?: string

Free form data set via the customData26 field in the analytics collector configuration

+

Optional customData26

customData26?: string

Free form data set via the customData26 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData27

customData27?: string

Free form data set via the customData27 field in the analytics collector configuration

+

Optional customData27

customData27?: string

Free form data set via the customData27 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData28

customData28?: string

Free form data set via the customData28 field in the analytics collector configuration

+

Optional customData28

customData28?: string

Free form data set via the customData28 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData29

customData29?: string

Free form data set via the customData29 field in the analytics collector configuration

+

Optional customData29

customData29?: string

Free form data set via the customData29 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData3

customData3?: string

Free form data set via the customData3 field in the analytics collector configuration

+

Optional customData3

customData3?: string

Free form data set via the customData3 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData30

customData30?: string

Free form data set via the customData30 field in the analytics collector configuration

+

Optional customData30

customData30?: string

Free form data set via the customData30 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData4

customData4?: string

Free form data set via the customData4 field in the analytics collector configuration

+

Optional customData4

customData4?: string

Free form data set via the customData4 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData5

customData5?: string

Free form data set via the customData5 field in the analytics collector configuration

+

Optional customData5

customData5?: string

Free form data set via the customData5 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData6

customData6?: string

Free form data set via the customData6 field in the analytics collector configuration

+

Optional customData6

customData6?: string

Free form data set via the customData6 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData7

customData7?: string

Free form data set via the customData7 field in the analytics collector configuration

+

Optional customData7

customData7?: string

Free form data set via the customData7 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData8

customData8?: string

Free form data set via the customData8 field in the analytics collector configuration

+

Optional customData8

customData8?: string

Free form data set via the customData8 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customData9

customData9?: string

Free form data set via the customData9 field in the analytics collector configuration

+

Optional customData9

customData9?: string

Free form data set via the customData9 field in the analytics collector configuration

Memberof

AnalyticsAdsImpressionSample

-

Optional customUserId

customUserId?: string

Custom user ID

+

Optional customUserId

customUserId?: string

Custom user ID

Memberof

AnalyticsAdsImpressionSample

-

Optional dealId

dealId?: string

Deal id

+

Optional dealId

dealId?: string

Deal id

Memberof

AnalyticsAdsImpressionSample

-

Optional deviceClass

deviceClass?: string

Type of device (Desktop, Phone, Tablet)

+

Optional deviceClass

deviceClass?: string

Type of device (Desktop, Phone, Tablet)

Memberof

AnalyticsAdsImpressionSample

-

Optional deviceType

deviceType?: string

Type of the device detected via User Agent

+

Optional deviceType

deviceType?: string

Type of the device detected via User Agent

Memberof

AnalyticsAdsImpressionSample

-

Optional domain

domain?: string

Domain the player was loaded on (.www is stripped away)

+

Optional domain

domain?: string

Domain the player was loaded on (.www is stripped away)

Memberof

AnalyticsAdsImpressionSample

-

Optional errorCode

errorCode?: number

Error code

+

Optional errorCode

errorCode?: number

Error code

Memberof

AnalyticsAdsImpressionSample

-

Optional errorData

errorData?: string

Error data

+

Optional errorData

errorData?: string

Error data

Memberof

AnalyticsAdsImpressionSample

-

Optional errorMessage

errorMessage?: string

Error message

+

Optional errorMessage

errorMessage?: string

Error message

Memberof

AnalyticsAdsImpressionSample

-

Optional errorPercentage

errorPercentage?: number

Error percentage

+

Optional errorPercentage

errorPercentage?: number

Error percentage

Memberof

AnalyticsAdsImpressionSample

-

Optional errorPosition

errorPosition?: number

Error position

+

Optional errorPosition

errorPosition?: number

Error position

Memberof

AnalyticsAdsImpressionSample

-

Optional exitPosition

exitPosition?: number

Exit position

+

Optional exitPosition

exitPosition?: number

Exit position

Memberof

AnalyticsAdsImpressionSample

-

Optional experimentName

experimentName?: string

A/B test experiment name

+

Optional experimentName

experimentName?: string

A/B test experiment name

Memberof

AnalyticsAdsImpressionSample

-

Optional ipAddress

ipAddress?: string

IP Address of the client

+

Optional ipAddress

ipAddress?: string

IP Address of the client

Memberof

AnalyticsAdsImpressionSample

-

Optional isp

isp?: string

The users Internet Service Provider inferred via the IP address

+

Optional isp

isp?: string

The users Internet Service Provider inferred via the IP address

Memberof

AnalyticsAdsImpressionSample

-

Optional language

language?: string

Language set in the browser

+

Optional language

language?: string

Language set in the browser

Memberof

AnalyticsAdsImpressionSample

-

Optional licenseKey

licenseKey?: string

Analytics license key

+

Optional licenseKey

licenseKey?: string

Analytics license key

Memberof

AnalyticsAdsImpressionSample

-

Optional manifestDownloadTime

manifestDownloadTime?: number

Manifest download time

+

Optional manifestDownloadTime

manifestDownloadTime?: number

Manifest download time

Memberof

AnalyticsAdsImpressionSample

-

Optional mediaPath

mediaPath?: string

Media path

+

Optional mediaPath

mediaPath?: string

Media path

Memberof

AnalyticsAdsImpressionSample

-

Optional mediaServer

mediaServer?: string

Media server

+

Optional mediaServer

mediaServer?: string

Media server

Memberof

AnalyticsAdsImpressionSample

-

Optional mediaUrl

mediaUrl?: string

Media url

+

Optional mediaUrl

mediaUrl?: string

Media url

Memberof

AnalyticsAdsImpressionSample

-

Optional midpoint

midpoint?: number

Midpoint

+

Optional midpoint

midpoint?: number

Midpoint

Memberof

AnalyticsAdsImpressionSample

-

Optional minSuggestedDuration

minSuggestedDuration?: number

Minimum suggested duration

+

Optional minSuggestedDuration

minSuggestedDuration?: number

Minimum suggested duration

Memberof

AnalyticsAdsImpressionSample

-

Optional operatingsystem

operatingsystem?: string

Operating system

+

Optional operatingsystem

operatingsystem?: string

Operating system

Memberof

AnalyticsAdsImpressionSample

-

Optional operatingsystemVersionMajor

operatingsystemVersionMajor?: string

Operating system version major

+

Optional operatingsystemVersionMajor

operatingsystemVersionMajor?: string

Operating system version major

Memberof

AnalyticsAdsImpressionSample

-

Optional operatingsystemVersionMinor

operatingsystemVersionMinor?: string

Operating system version minor

+

Optional operatingsystemVersionMinor

operatingsystemVersionMinor?: string

Operating system version minor

Memberof

AnalyticsAdsImpressionSample

-

Optional pageLoadTime

pageLoadTime?: number

Time in milliseconds the page took to load

+

Optional pageLoadTime

pageLoadTime?: number

Time in milliseconds the page took to load

Memberof

AnalyticsAdsImpressionSample

-

Optional pageLoadType

pageLoadType?: number

Player load type. 1 = Foreground, 2 = Background

+

Optional pageLoadType

pageLoadType?: number

Player load type. 1 = Foreground, 2 = Background

Memberof

AnalyticsAdsImpressionSample

-

Optional path

path?: string

path on the website

+

Optional path

path?: string

path on the website

Memberof

AnalyticsAdsImpressionSample

-

Optional percentageInViewport

percentageInViewport?: number

Percentage in viewport

+

Optional percentageInViewport

percentageInViewport?: number

Percentage in viewport

Memberof

AnalyticsAdsImpressionSample

-

Optional platform

platform?: string

Platform the player is running on (web, android, ios)

+

Optional platform

platform?: string

Platform the player is running on (web, android, ios)

Memberof

AnalyticsAdsImpressionSample

-

Optional playPercentage

playPercentage?: number

Play percentage

+

Optional playPercentage

playPercentage?: number

Play percentage

Memberof

AnalyticsAdsImpressionSample

-

Optional player

player?: string

Video player being used for this session

+

Optional player

player?: string

Video player being used for this session

Memberof

AnalyticsAdsImpressionSample

-

Optional playerKey

playerKey?: string

Player license key

+

Optional playerKey

playerKey?: string

Player license key

Memberof

AnalyticsAdsImpressionSample

-

Optional playerStartuptime

playerStartuptime?: number

Time in milliseconds the player took to start up

+

Optional playerStartuptime

playerStartuptime?: number

Time in milliseconds the player took to start up

Memberof

AnalyticsAdsImpressionSample

-

Optional playerTech

playerTech?: string

HTML or native playback

+

Optional playerTech

playerTech?: string

HTML or native playback

Memberof

AnalyticsAdsImpressionSample

-

Optional playerVersion

playerVersion?: string

Player software version

+

Optional playerVersion

playerVersion?: string

Player software version

Memberof

AnalyticsAdsImpressionSample

-

Optional quartile1

quartile1?: number

Quartile 1

+

Optional quartile1

quartile1?: number

Quartile 1

Memberof

AnalyticsAdsImpressionSample

-

Optional quartile3

quartile3?: number

Quartile 3

+

Optional quartile3

quartile3?: number

Quartile 3

Memberof

AnalyticsAdsImpressionSample

-

Optional region

region?: string

Geographic region (ISO 3166-2 code)

+

Optional region

region?: string

Geographic region (ISO 3166-2 code)

Memberof

AnalyticsAdsImpressionSample

-

Optional screenHeight

screenHeight?: number

Screen as reported by the browser

+

Optional screenHeight

screenHeight?: number

Screen as reported by the browser

Memberof

AnalyticsAdsImpressionSample

-

Optional screenOrientation

screenOrientation?: string

Screen orientation (PORTRAIT, LANDSCAPE OR UNKNOWN)

+

Optional screenOrientation

screenOrientation?: string

Screen orientation (PORTRAIT, LANDSCAPE OR UNKNOWN)

Memberof

AnalyticsAdsImpressionSample

-

Optional screenWidth

screenWidth?: number

Screen as reported by the browser

+

Optional screenWidth

screenWidth?: number

Screen as reported by the browser

Memberof

AnalyticsAdsImpressionSample

-

Optional size

size?: string

Video size (FULLSCREEN or WINDOW)

+

Optional size

size?: string

Video size (FULLSCREEN or WINDOW)

Memberof

AnalyticsAdsImpressionSample

-

Optional skipPercentage

skipPercentage?: number

Skip percentage

+

Optional skipPercentage

skipPercentage?: number

Skip percentage

Memberof

AnalyticsAdsImpressionSample

-

Optional skipPosition

skipPosition?: number

Skip position

+

Optional skipPosition

skipPosition?: number

Skip position

Memberof

AnalyticsAdsImpressionSample

-

Optional skipped

skipped?: number

Skipped

+

Optional skipped

skipped?: number

Skipped

Memberof

AnalyticsAdsImpressionSample

-

Optional started

started?: number

Started

+

Optional started

started?: number

Started

Memberof

AnalyticsAdsImpressionSample

-

Optional streamFormat

streamFormat?: string

Format of the stream (HLS, DASH, Progressive MP4)

+

Optional streamFormat

streamFormat?: string

Format of the stream (HLS, DASH, Progressive MP4)

Memberof

AnalyticsAdsImpressionSample

-

Optional surveyUrl

surveyUrl?: string

Survey url

+

Optional surveyUrl

surveyUrl?: string

Survey url

Memberof

AnalyticsAdsImpressionSample

-

Optional time

time?: number

Current time in milliseconds

+

Optional time

time?: number

Current time in milliseconds

Memberof

AnalyticsAdsImpressionSample

-

Optional timeInViewport

timeInViewport?: number

Time in viewport

+

Optional timeInViewport

timeInViewport?: number

Time in viewport

Memberof

AnalyticsAdsImpressionSample

-

Optional timePlayed

timePlayed?: number

Time played

+

Optional timePlayed

timePlayed?: number

Time played

Memberof

AnalyticsAdsImpressionSample

-

Optional universalAdIdRegistry

universalAdIdRegistry?: string

Universal ad id registry

+

Optional universalAdIdRegistry

universalAdIdRegistry?: string

Universal ad id registry

Memberof

AnalyticsAdsImpressionSample

-

Optional universalAdIdValue

universalAdIdValue?: string

Universal ad id value

+

Optional universalAdIdValue

universalAdIdValue?: string

Universal ad id value

Memberof

AnalyticsAdsImpressionSample

-

Optional userId

userId?: string

ID that is persisted across sessions to identify a browser

+

Optional userId

userId?: string

ID that is persisted across sessions to identify a browser

Memberof

AnalyticsAdsImpressionSample

-

Optional videoBitrate

videoBitrate?: number

Bitrate of the played back video rendition

+

Optional videoBitrate

videoBitrate?: number

Bitrate of the played back video rendition

Memberof

AnalyticsAdsImpressionSample

-

Optional videoId

videoId?: string

ID of the video

+

Optional videoId

videoId?: string

ID of the video

Memberof

AnalyticsAdsImpressionSample

-

Optional videoImpressionId

videoImpressionId?: string

ID of related video impression

+

Optional videoImpressionId

videoImpressionId?: string

ID of related video impression

Memberof

AnalyticsAdsImpressionSample

-

Optional videoTitle

videoTitle?: string

Free form human readable video ad title

+

Optional videoTitle

videoTitle?: string

Free form human readable video ad title

Memberof

AnalyticsAdsImpressionSample

-

Optional videoWindowHeight

videoWindowHeight?: number

Height of the video player on the page

+

Optional videoWindowHeight

videoWindowHeight?: number

Height of the video player on the page

Memberof

AnalyticsAdsImpressionSample

-

Optional videoWindowWidth

videoWindowWidth?: number

Width of the video player on the page

+

Optional videoWindowWidth

videoWindowWidth?: number

Width of the video player on the page

Memberof

AnalyticsAdsImpressionSample

-

Settings

Member Visibility

Theme

On This Page

constructoradClickthroughUrladDescriptionadDurationadFallbackIndexadIdadIdPlayeradImpressionIdadIsPersistentadModuleadModuleVersionadOffsetadPlaybackHeightadPlaybackWidthadPodPositionadPositionadPreloadOffsetadReplaceContentDurationadScheduleTimeadSkipAfteradSkippableadStartupTimeadSystemadTagPathadTagServeradTagTypeadTagUrladTitleadWrapperAdsCountadvertiserNameanalyticsVersionapiFrameworkapiorgIdapiuserIdaudioBitrateautoplaybrowserbrowserIsBotbrowserVersionMajorbrowserVersionMinorcdnProvidercityclickPercentageclickPositionclickedclientTimeclosePercentageclosePositionclosedcompletedcountrycreativeAdIdcreativeIdcustomData1customData10customData11customData12customData13customData14customData15customData16customData17customData18customData19customData2customData20customData21customData22customData23customData24customData25customData26customData27customData28customData29customData3customData30customData4customData5customData6customData7customData8customData9customUserIddealIddeviceClassdeviceTypedomainerrorCodeerrorDataerrorMessageerrorPercentageerrorPositionexitPositionexperimentNameipAddressisplanguagelicenseKeymanifestDownloadTimemediaPathmediaServermediaUrlmidpointminSuggestedDurationoperatingsystemoperatingsystemVersionMajoroperatingsystemVersionMinorpageLoadTimepageLoadTypepathpercentageInViewportplatformplayPercentageplayerplayerKeyplayerStartuptimeplayerTechplayerVersionquartile1quartile3regionscreenHeightscreenOrientationscreenWidthsizeskipPercentageskipPositionskippedstartedstreamFormatsurveyUrltimetimeInViewporttimePlayeduniversalAdIdRegistryuniversalAdIdValueuserIdvideoBitratevideoIdvideoImpressionIdvideoTitlevideoWindowHeightvideoWindowWidth
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoradClickthroughUrladDescriptionadDurationadFallbackIndexadIdadIdPlayeradImpressionIdadIsPersistentadModuleadModuleVersionadOffsetadPlaybackHeightadPlaybackWidthadPodPositionadPositionadPreloadOffsetadReplaceContentDurationadScheduleTimeadSkipAfteradSkippableadStartupTimeadSystemadTagPathadTagServeradTagTypeadTagUrladTitleadWrapperAdsCountadvertiserNameanalyticsVersionapiFrameworkapiorgIdapiuserIdaudioBitrateautoplaybrowserbrowserIsBotbrowserVersionMajorbrowserVersionMinorcdnProvidercityclickPercentageclickPositionclickedclientTimeclosePercentageclosePositionclosedcompletedcountrycreativeAdIdcreativeIdcustomData1customData10customData11customData12customData13customData14customData15customData16customData17customData18customData19customData2customData20customData21customData22customData23customData24customData25customData26customData27customData28customData29customData3customData30customData4customData5customData6customData7customData8customData9customUserIddealIddeviceClassdeviceTypedomainerrorCodeerrorDataerrorMessageerrorPercentageerrorPositionexitPositionexperimentNameipAddressisplanguagelicenseKeymanifestDownloadTimemediaPathmediaServermediaUrlmidpointminSuggestedDurationoperatingsystemoperatingsystemVersionMajoroperatingsystemVersionMinorpageLoadTimepageLoadTypepathpercentageInViewportplatformplayPercentageplayerplayerKeyplayerStartuptimeplayerTechplayerVersionquartile1quartile3regionscreenHeightscreenOrientationscreenWidthsizeskipPercentageskipPositionskippedstartedstreamFormatsurveyUrltimetimeInViewporttimePlayeduniversalAdIdRegistryuniversalAdIdValueuserIdvideoBitratevideoIdvideoImpressionIdvideoTitlevideoWindowHeightvideoWindowWidth
\ No newline at end of file diff --git a/docs/classes/AnalyticsAdsImpressionsResponse.html b/docs/classes/AnalyticsAdsImpressionsResponse.html index cff62cbef..c4dcca404 100644 --- a/docs/classes/AnalyticsAdsImpressionsResponse.html +++ b/docs/classes/AnalyticsAdsImpressionsResponse.html @@ -1,5 +1,5 @@ AnalyticsAdsImpressionsResponse | @bitmovin/api-sdk

Class AnalyticsAdsImpressionsResponse

Export

AnalyticsAdsImpressionsResponse

-

Constructors

constructor +

Constructors

constructor

Properties

adsImpressions? -

Constructors

constructor

Properties

Optional adsImpressions

adsImpressions?: AnalyticsAdsImpressionSample[]

Memberof

AnalyticsAdsImpressionsResponse

-

Settings

Member Visibility

Theme

On This Page

constructoradsImpressions
\ No newline at end of file +

Constructors

constructor

Properties

Optional adsImpressions

adsImpressions?: AnalyticsAdsImpressionSample[]

Memberof

AnalyticsAdsImpressionsResponse

+

Settings

Member Visibility

Theme

On This Page

constructoradsImpressions
\ No newline at end of file diff --git a/docs/classes/AnalyticsAvgConcurrentViewersResponse.html b/docs/classes/AnalyticsAvgConcurrentViewersResponse.html index aa6130c1d..7b61d9c46 100644 --- a/docs/classes/AnalyticsAvgConcurrentViewersResponse.html +++ b/docs/classes/AnalyticsAvgConcurrentViewersResponse.html @@ -1,10 +1,10 @@ AnalyticsAvgConcurrentViewersResponse | @bitmovin/api-sdk

Class AnalyticsAvgConcurrentViewersResponse

Export

AnalyticsAvgConcurrentViewersResponse

-

Constructors

constructor +

Constructors

constructor

Properties

columnLabels? rowCount? rows? -

Constructors

constructor

Properties

Optional columnLabels

columnLabels?: AnalyticsColumnLabel[]

Memberof

AnalyticsAvgConcurrentViewersResponse

-

Optional rowCount

rowCount?: number

Number of rows returned

+

Constructors

constructor

Properties

Optional columnLabels

columnLabels?: AnalyticsColumnLabel[]

Memberof

AnalyticsAvgConcurrentViewersResponse

+

Optional rowCount

rowCount?: number

Number of rows returned

Memberof

AnalyticsAvgConcurrentViewersResponse

-

Optional rows

rows?: number[]

Memberof

AnalyticsAvgConcurrentViewersResponse

-

Settings

Member Visibility

Theme

On This Page

constructorcolumnLabelsrowCountrows
\ No newline at end of file +

Optional rows

rows?: number[]

Memberof

AnalyticsAvgConcurrentViewersResponse

+

Settings

Member Visibility

Theme

On This Page

constructorcolumnLabelsrowCountrows
\ No newline at end of file diff --git a/docs/classes/AnalyticsAvgDroppedFramesResponse.html b/docs/classes/AnalyticsAvgDroppedFramesResponse.html index f8f2cc33d..cf630805e 100644 --- a/docs/classes/AnalyticsAvgDroppedFramesResponse.html +++ b/docs/classes/AnalyticsAvgDroppedFramesResponse.html @@ -1,10 +1,10 @@ AnalyticsAvgDroppedFramesResponse | @bitmovin/api-sdk

Class AnalyticsAvgDroppedFramesResponse

Export

AnalyticsAvgDroppedFramesResponse

-

Constructors

constructor +

Constructors

constructor

Properties

columnLabels? rowCount? rows? -

Constructors

constructor

Properties

Optional columnLabels

columnLabels?: AnalyticsColumnLabel[]

Memberof

AnalyticsAvgDroppedFramesResponse

-

Optional rowCount

rowCount?: number

Number of rows returned

+

Constructors

constructor

Properties

Optional columnLabels

columnLabels?: AnalyticsColumnLabel[]

Memberof

AnalyticsAvgDroppedFramesResponse

+

Optional rowCount

rowCount?: number

Number of rows returned

Memberof

AnalyticsAvgDroppedFramesResponse

-

Optional rows

rows?: number[]

Memberof

AnalyticsAvgDroppedFramesResponse

-

Settings

Member Visibility

Theme

On This Page

constructorcolumnLabelsrowCountrows
\ No newline at end of file +

Optional rows

rows?: number[]

Memberof

AnalyticsAvgDroppedFramesResponse

+

Settings

Member Visibility

Theme

On This Page

constructorcolumnLabelsrowCountrows
\ No newline at end of file diff --git a/docs/classes/AnalyticsAvgQueryRequest.html b/docs/classes/AnalyticsAvgQueryRequest.html index f424ce771..1d407bcf8 100644 --- a/docs/classes/AnalyticsAvgQueryRequest.html +++ b/docs/classes/AnalyticsAvgQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsAvgQueryRequest | @bitmovin/api-sdk

Class AnalyticsAvgQueryRequest

Export

AnalyticsAvgQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsAzureOutput.html b/docs/classes/AnalyticsAzureOutput.html index 0ec1b91f7..3192dd4a1 100644 --- a/docs/classes/AnalyticsAzureOutput.html +++ b/docs/classes/AnalyticsAzureOutput.html @@ -1,5 +1,5 @@ AnalyticsAzureOutput | @bitmovin/api-sdk

Class AnalyticsAzureOutput

Export

AnalyticsAzureOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accountKey? accountName? acl? @@ -13,25 +13,25 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accountKey

accountKey?: string

Microsoft Azure Account Access Key with the Contributor Role (required)

+

Constructors

constructor

Properties

Optional accountKey

accountKey?: string

Microsoft Azure Account Access Key with the Contributor Role (required)

Memberof

AnalyticsAzureOutput

-

Optional accountName

accountName?: string

Azure Account Name (required)

+

Optional accountName

accountName?: string

Azure Account Name (required)

Memberof

AnalyticsAzureOutput

-

Optional acl

acl?: AclEntry[]

Memberof

AnalyticsOutput

-

Optional container

container?: string

Microsoft Azure container name (required)

+

Optional acl

acl?: AclEntry[]

Memberof

AnalyticsOutput

+

Optional container

container?: string

Microsoft Azure container name (required)

Memberof

AnalyticsAzureOutput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: AnalyticsOutputType = AnalyticsOutputType.AZURE

Discriminator property for AnalyticsOutput

+

Readonly type

type: AnalyticsOutputType = AnalyticsOutputType.AZURE

Discriminator property for AnalyticsOutput

Memberof

AnalyticsAzureOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AZURE: string;
    GCS_SERVICE_ACCOUNT: string;
    S3_ROLE_BASED: string;
} = ...

Type declaration

  • AZURE: string
  • GCS_SERVICE_ACCOUNT: string
  • S3_ROLE_BASED: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccountKeyaccountNameaclcontainercreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AZURE: string;
    GCS_SERVICE_ACCOUNT: string;
    S3_ROLE_BASED: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccountKeyaccountNameaclcontainercreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsColumnLabel.html b/docs/classes/AnalyticsColumnLabel.html index 402211ecf..b889ec091 100644 --- a/docs/classes/AnalyticsColumnLabel.html +++ b/docs/classes/AnalyticsColumnLabel.html @@ -1,7 +1,7 @@ AnalyticsColumnLabel | @bitmovin/api-sdk

Class AnalyticsColumnLabel

Export

AnalyticsColumnLabel

-

Constructors

constructor +

Constructors

constructor

Properties

key? label? -

Constructors

constructor

Properties

Optional key

key?: string

Memberof

AnalyticsColumnLabel

-

Optional label

label?: string

Memberof

AnalyticsColumnLabel

-

Settings

Member Visibility

Theme

On This Page

constructorkeylabel
\ No newline at end of file +

Constructors

constructor

Properties

Optional key

key?: string

Memberof

AnalyticsColumnLabel

+

Optional label

label?: string

Memberof

AnalyticsColumnLabel

+

Settings

Member Visibility

Theme

On This Page

constructorkeylabel
\ No newline at end of file diff --git a/docs/classes/AnalyticsContainsFilter.html b/docs/classes/AnalyticsContainsFilter.html index ce008fcbd..b4639a388 100644 --- a/docs/classes/AnalyticsContainsFilter.html +++ b/docs/classes/AnalyticsContainsFilter.html @@ -1,12 +1,12 @@ AnalyticsContainsFilter | @bitmovin/api-sdk

Class AnalyticsContainsFilter

Export

AnalyticsContainsFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.CONTAINS

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.CONTAINS

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsContainsFilter

-

Optional value

value?: any

Memberof

AnalyticsContainsFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AnalyticsContainsFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsContextDescription.html b/docs/classes/AnalyticsContextDescription.html index f55244c6b..50765dd9a 100644 --- a/docs/classes/AnalyticsContextDescription.html +++ b/docs/classes/AnalyticsContextDescription.html @@ -1,7 +1,7 @@ AnalyticsContextDescription | @bitmovin/api-sdk

Class AnalyticsContextDescription

Export

AnalyticsContextDescription

-

Constructors

constructor +

Constructors

constructor

Properties

description? label? -

Constructors

constructor

Properties

Optional description

description?: string

Memberof

AnalyticsContextDescription

-

Optional label

label?: string

Memberof

AnalyticsContextDescription

-

Settings

Member Visibility

Theme

On This Page

constructordescriptionlabel
\ No newline at end of file +

Constructors

constructor

Properties

Optional description

description?: string

Memberof

AnalyticsContextDescription

+

Optional label

label?: string

Memberof

AnalyticsContextDescription

+

Settings

Member Visibility

Theme

On This Page

constructordescriptionlabel
\ No newline at end of file diff --git a/docs/classes/AnalyticsCountQueryRequest.html b/docs/classes/AnalyticsCountQueryRequest.html index a15be17e0..8b2a78d49 100644 --- a/docs/classes/AnalyticsCountQueryRequest.html +++ b/docs/classes/AnalyticsCountQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsCountQueryRequest | @bitmovin/api-sdk

Class AnalyticsCountQueryRequest

Export

AnalyticsCountQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsEqualFilter.html b/docs/classes/AnalyticsEqualFilter.html index 44e94dd4e..64e607de2 100644 --- a/docs/classes/AnalyticsEqualFilter.html +++ b/docs/classes/AnalyticsEqualFilter.html @@ -1,12 +1,12 @@ AnalyticsEqualFilter | @bitmovin/api-sdk

Class AnalyticsEqualFilter

Export

AnalyticsEqualFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.EQ

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.EQ

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsEqualFilter

-

Optional value

value?: any

Memberof

AnalyticsEqualFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AnalyticsEqualFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsErrorData.html b/docs/classes/AnalyticsErrorData.html index df75f6fb4..b6f3148a0 100644 --- a/docs/classes/AnalyticsErrorData.html +++ b/docs/classes/AnalyticsErrorData.html @@ -1,11 +1,11 @@ AnalyticsErrorData | @bitmovin/api-sdk

Class AnalyticsErrorData

Export

AnalyticsErrorData

-

Constructors

constructor +

Constructors

constructor

Properties

additionalData? exceptionMessage? exceptionStacktrace? -

Constructors

constructor

Properties

Optional additionalData

additionalData?: string

Additional error data

+

Constructors

constructor

Properties

Optional additionalData

additionalData?: string

Additional error data

Memberof

AnalyticsErrorData

-

Optional exceptionMessage

exceptionMessage?: string

Exception message

+

Optional exceptionMessage

exceptionMessage?: string

Exception message

Memberof

AnalyticsErrorData

-

Optional exceptionStacktrace

exceptionStacktrace?: string[]

Memberof

AnalyticsErrorData

-

Settings

Member Visibility

Theme

On This Page

constructoradditionalDataexceptionMessageexceptionStacktrace
\ No newline at end of file +

Optional exceptionStacktrace

exceptionStacktrace?: string[]

Memberof

AnalyticsErrorData

+

Settings

Member Visibility

Theme

On This Page

constructoradditionalDataexceptionMessageexceptionStacktrace
\ No newline at end of file diff --git a/docs/classes/AnalyticsErrorDetail.html b/docs/classes/AnalyticsErrorDetail.html index 09db2b2c0..431178e59 100644 --- a/docs/classes/AnalyticsErrorDetail.html +++ b/docs/classes/AnalyticsErrorDetail.html @@ -1,5 +1,5 @@ AnalyticsErrorDetail | @bitmovin/api-sdk

Class AnalyticsErrorDetail

Export

AnalyticsErrorDetail

-

Constructors

constructor +

Constructors

constructor

Properties

clientTime? code? errorData? @@ -7,16 +7,16 @@ httpRequests? message? time? -

Constructors

constructor

Properties

Optional clientTime

clientTime?: Date

Client timestamp

+

Constructors

constructor

Properties

Optional clientTime

clientTime?: Date

Client timestamp

Memberof

AnalyticsErrorDetail

-

Optional code

code?: number

Error code

+

Optional code

code?: number

Error code

Memberof

AnalyticsErrorDetail

-

Optional errorData

errorData?: AnalyticsErrorData

Memberof

AnalyticsErrorDetail

-

Optional errorId

errorId?: number

Error id

+

Optional errorData

errorData?: AnalyticsErrorData

Memberof

AnalyticsErrorDetail

+

Optional errorId

errorId?: number

Error id

Memberof

AnalyticsErrorDetail

-

Optional httpRequests

httpRequests?: AnalyticsHttpRequest[]

Memberof

AnalyticsErrorDetail

-

Optional message

message?: string

Error message

+

Optional httpRequests

httpRequests?: AnalyticsHttpRequest[]

Memberof

AnalyticsErrorDetail

+

Optional message

message?: string

Error message

Memberof

AnalyticsErrorDetail

-

Optional time

time?: Date

Server timestamp

+

Optional time

time?: Date

Server timestamp

Memberof

AnalyticsErrorDetail

-

Settings

Member Visibility

Theme

On This Page

constructorclientTimecodeerrorDataerrorIdhttpRequestsmessagetime
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorclientTimecodeerrorDataerrorIdhttpRequestsmessagetime
\ No newline at end of file diff --git a/docs/classes/AnalyticsErrorDetailsResponse.html b/docs/classes/AnalyticsErrorDetailsResponse.html index 066548d6e..024a93a6a 100644 --- a/docs/classes/AnalyticsErrorDetailsResponse.html +++ b/docs/classes/AnalyticsErrorDetailsResponse.html @@ -1,5 +1,5 @@ AnalyticsErrorDetailsResponse | @bitmovin/api-sdk

Class AnalyticsErrorDetailsResponse

Export

AnalyticsErrorDetailsResponse

-

Constructors

constructor +

Constructors

constructor

Properties

errorDetails? -

Constructors

constructor

Properties

Optional errorDetails

errorDetails?: AnalyticsErrorDetail[]

Memberof

AnalyticsErrorDetailsResponse

-

Settings

Member Visibility

Theme

On This Page

constructorerrorDetails
\ No newline at end of file +

Constructors

constructor

Properties

Optional errorDetails

errorDetails?: AnalyticsErrorDetail[]

Memberof

AnalyticsErrorDetailsResponse

+

Settings

Member Visibility

Theme

On This Page

constructorerrorDetails
\ No newline at end of file diff --git a/docs/classes/AnalyticsExportTask.html b/docs/classes/AnalyticsExportTask.html index 72e88670b..659527965 100644 --- a/docs/classes/AnalyticsExportTask.html +++ b/docs/classes/AnalyticsExportTask.html @@ -1,5 +1,5 @@ AnalyticsExportTask | @bitmovin/api-sdk

Class AnalyticsExportTask

Export

AnalyticsExportTask

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

columns? description? endTime? @@ -14,28 +14,28 @@ startedAt? status? type? -

Constructors

constructor

Properties

Optional columns

columns?: string[]

Memberof

AnalyticsExportTask

-

Optional description

description?: string

Export task description

+

Constructors

constructor

Properties

Optional columns

columns?: string[]

Memberof

AnalyticsExportTask

+

Optional description

description?: string

Export task description

Memberof

AnalyticsExportTask

-

Optional endTime

endTime?: Date

End of timeframe which is exported in UTC format (required)

+

Optional endTime

endTime?: Date

End of timeframe which is exported in UTC format (required)

Memberof

AnalyticsExportTask

-

Optional fileFormat

fileFormat?: AnalyticsExportFileFormat

File format of export file

+

Optional fileFormat

fileFormat?: AnalyticsExportFileFormat

File format of export file

Memberof

AnalyticsExportTask

-

Optional finishedAt

finishedAt?: Date

UTC timestamp when the export task finished

+

Optional finishedAt

finishedAt?: Date

UTC timestamp when the export task finished

Memberof

AnalyticsExportTask

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional licenseKey

licenseKey?: string

License key (required)

+

Optional licenseKey

licenseKey?: string

License key (required)

Memberof

AnalyticsExportTask

-

Optional name

name?: string

Name of the export task (required)

+

Optional name

name?: string

Name of the export task (required)

Memberof

AnalyticsExportTask

-

Optional output

output?: AnalyticsExportTaskOutputTarget

Memberof

AnalyticsExportTask

-

Optional progress

progress?: number

Progress of the export task

+

Optional output

output?: AnalyticsExportTaskOutputTarget

Memberof

AnalyticsExportTask

+

Optional progress

progress?: number

Progress of the export task

Memberof

AnalyticsExportTask

-

Optional startTime

startTime?: Date

Start of timeframe which is exported in UTC format (required)

+

Optional startTime

startTime?: Date

Start of timeframe which is exported in UTC format (required)

Memberof

AnalyticsExportTask

-

Optional startedAt

startedAt?: Date

UTC timestamp when the export task started

+

Optional startedAt

startedAt?: Date

UTC timestamp when the export task started

Memberof

AnalyticsExportTask

-

Optional status

status?: AnalyticsExportStatus

Memberof

AnalyticsExportTask

-

Optional type

type?: AnalyticsExportType

Memberof

AnalyticsExportTask

-

Settings

Member Visibility

Theme

On This Page

constructorcolumnsdescriptionendTimefileFormatfinishedAtidlicenseKeynameoutputprogressstartTimestartedAtstatustype
\ No newline at end of file +

Optional status

status?: AnalyticsExportStatus

Memberof

AnalyticsExportTask

+

Optional type

type?: AnalyticsExportType

Memberof

AnalyticsExportTask

+

Settings

Member Visibility

Theme

On This Page

constructorcolumnsdescriptionendTimefileFormatfinishedAtidlicenseKeynameoutputprogressstartTimestartedAtstatustype
\ No newline at end of file diff --git a/docs/classes/AnalyticsExportTaskOutputTarget.html b/docs/classes/AnalyticsExportTaskOutputTarget.html index d8ef463d3..87b283f18 100644 --- a/docs/classes/AnalyticsExportTaskOutputTarget.html +++ b/docs/classes/AnalyticsExportTaskOutputTarget.html @@ -1,9 +1,9 @@ AnalyticsExportTaskOutputTarget | @bitmovin/api-sdk

Class AnalyticsExportTaskOutputTarget

Export

AnalyticsExportTaskOutputTarget

-

Constructors

constructor +

Constructors

constructor

Properties

outputId? outputPath? -

Constructors

constructor

Properties

Optional outputId

outputId?: string

Id of the output that should be used (required)

+

Constructors

constructor

Properties

Optional outputId

outputId?: string

Id of the output that should be used (required)

Memberof

AnalyticsExportTaskOutputTarget

-

Optional outputPath

outputPath?: string

Path where the export should be saved (required)

+

Optional outputPath

outputPath?: string

Path where the export should be saved (required)

Memberof

AnalyticsExportTaskOutputTarget

-

Settings

Member Visibility

Theme

On This Page

constructoroutputIdoutputPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoroutputIdoutputPath
\ No newline at end of file diff --git a/docs/classes/AnalyticsGcsServiceAccountOutput.html b/docs/classes/AnalyticsGcsServiceAccountOutput.html index 823eaf99d..cfd584878 100644 --- a/docs/classes/AnalyticsGcsServiceAccountOutput.html +++ b/docs/classes/AnalyticsGcsServiceAccountOutput.html @@ -1,5 +1,5 @@ AnalyticsGcsServiceAccountOutput | @bitmovin/api-sdk

Class AnalyticsGcsServiceAccountOutput

Export

AnalyticsGcsServiceAccountOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? bucketName? cloudRegion? @@ -13,25 +13,25 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Memberof

AnalyticsOutput

-

Optional bucketName

bucketName?: string

Name of the bucket (required)

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Memberof

AnalyticsOutput

+

Optional bucketName

bucketName?: string

Name of the bucket (required)

Memberof

AnalyticsGcsServiceAccountOutput

-

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

+

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

Memberof

AnalyticsGcsServiceAccountOutput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional serviceAccountCredentials

serviceAccountCredentials?: string

GCS projectId (required)

+

Optional serviceAccountCredentials

serviceAccountCredentials?: string

GCS projectId (required)

Memberof

AnalyticsGcsServiceAccountOutput

-

Readonly type

type: AnalyticsOutputType = AnalyticsOutputType.GCS_SERVICE_ACCOUNT

Discriminator property for AnalyticsOutput

+

Readonly type

type: AnalyticsOutputType = AnalyticsOutputType.GCS_SERVICE_ACCOUNT

Discriminator property for AnalyticsOutput

Memberof

AnalyticsGcsServiceAccountOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AZURE: string;
    GCS_SERVICE_ACCOUNT: string;
    S3_ROLE_BASED: string;
} = ...

Type declaration

  • AZURE: string
  • GCS_SERVICE_ACCOUNT: string
  • S3_ROLE_BASED: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclbucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnameserviceAccountCredentialstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AZURE: string;
    GCS_SERVICE_ACCOUNT: string;
    S3_ROLE_BASED: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclbucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnameserviceAccountCredentialstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsGreaterThanFilter.html b/docs/classes/AnalyticsGreaterThanFilter.html index b9291de52..cf8d0b830 100644 --- a/docs/classes/AnalyticsGreaterThanFilter.html +++ b/docs/classes/AnalyticsGreaterThanFilter.html @@ -1,12 +1,12 @@ AnalyticsGreaterThanFilter | @bitmovin/api-sdk

Class AnalyticsGreaterThanFilter

Export

AnalyticsGreaterThanFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.GT

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.GT

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsGreaterThanFilter

-

Optional value

value?: any

Memberof

AnalyticsGreaterThanFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AnalyticsGreaterThanFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsGreaterThanOrEqualFilter.html b/docs/classes/AnalyticsGreaterThanOrEqualFilter.html index 660211f2f..29e27e91f 100644 --- a/docs/classes/AnalyticsGreaterThanOrEqualFilter.html +++ b/docs/classes/AnalyticsGreaterThanOrEqualFilter.html @@ -1,12 +1,12 @@ AnalyticsGreaterThanOrEqualFilter | @bitmovin/api-sdk

Class AnalyticsGreaterThanOrEqualFilter

Export

AnalyticsGreaterThanOrEqualFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.GTE

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.GTE

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsGreaterThanOrEqualFilter

-

Optional value

value?: any

Memberof

AnalyticsGreaterThanOrEqualFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AnalyticsGreaterThanOrEqualFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsHttpRequest.html b/docs/classes/AnalyticsHttpRequest.html index 745e2a5a7..5b55debdc 100644 --- a/docs/classes/AnalyticsHttpRequest.html +++ b/docs/classes/AnalyticsHttpRequest.html @@ -1,5 +1,5 @@ AnalyticsHttpRequest | @bitmovin/api-sdk

Class AnalyticsHttpRequest

Export

AnalyticsHttpRequest

-

Constructors

constructor +

Constructors

constructor

Properties

clientTime? downloadTime? httpStatus? @@ -9,21 +9,21 @@ timeToFirstByte? type? url? -

Constructors

constructor

Properties

Optional clientTime

clientTime?: Date

Client timestamp

+

Constructors

constructor

Properties

Optional clientTime

clientTime?: Date

Client timestamp

Memberof

AnalyticsHttpRequest

-

Optional downloadTime

downloadTime?: number

Download time

+

Optional downloadTime

downloadTime?: number

Download time

Memberof

AnalyticsHttpRequest

-

Optional httpStatus

httpStatus?: number

Http request status

+

Optional httpStatus

httpStatus?: number

Http request status

Memberof

AnalyticsHttpRequest

-

Optional lastRedirectLocation

lastRedirectLocation?: string

Last redirect location

+

Optional lastRedirectLocation

lastRedirectLocation?: string

Last redirect location

Memberof

AnalyticsHttpRequest

-

Optional size

size?: number

Size

+

Optional size

size?: number

Size

Memberof

AnalyticsHttpRequest

-

Optional success

success?: boolean

Was http request successful

+

Optional success

success?: boolean

Was http request successful

Memberof

AnalyticsHttpRequest

-

Optional timeToFirstByte

timeToFirstByte?: number

Time to first byte

+

Optional timeToFirstByte

timeToFirstByte?: number

Time to first byte

Memberof

AnalyticsHttpRequest

-

Optional type

type?: AnalyticsHttpRequestType

Memberof

AnalyticsHttpRequest

-

Optional url

url?: string

Http request URL

+

Optional type

type?: AnalyticsHttpRequestType

Memberof

AnalyticsHttpRequest

+

Optional url

url?: string

Http request URL

Memberof

AnalyticsHttpRequest

-

Settings

Member Visibility

Theme

On This Page

constructorclientTimedownloadTimehttpStatuslastRedirectLocationsizesuccesstimeToFirstBytetypeurl
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorclientTimedownloadTimehttpStatuslastRedirectLocationsizesuccesstimeToFirstBytetypeurl
\ No newline at end of file diff --git a/docs/classes/AnalyticsImpressionListItem.html b/docs/classes/AnalyticsImpressionListItem.html index 2ee5a26b0..f8544d033 100644 --- a/docs/classes/AnalyticsImpressionListItem.html +++ b/docs/classes/AnalyticsImpressionListItem.html @@ -1,6 +1,6 @@ AnalyticsImpressionListItem | @bitmovin/api-sdk

Class AnalyticsImpressionListItem

Export

AnalyticsImpressionListItem

-

Constructors

constructor +

Constructors

constructor

Properties

impressionId? -

Constructors

constructor

Properties

Optional impressionId

impressionId?: string

Random UUID that is used to identify a session (required)

+

Constructors

constructor

Properties

Optional impressionId

impressionId?: string

Random UUID that is used to identify a session (required)

Memberof

AnalyticsImpressionListItem

-

Settings

Member Visibility

Theme

On This Page

constructorimpressionId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorimpressionId
\ No newline at end of file diff --git a/docs/classes/AnalyticsImpressionsQuery.html b/docs/classes/AnalyticsImpressionsQuery.html index 5eeb612b7..62ea0a614 100644 --- a/docs/classes/AnalyticsImpressionsQuery.html +++ b/docs/classes/AnalyticsImpressionsQuery.html @@ -1,18 +1,18 @@ AnalyticsImpressionsQuery | @bitmovin/api-sdk

Class AnalyticsImpressionsQuery

Export

AnalyticsImpressionsQuery

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

end? filters? licenseKey? limit? start? -

Constructors

constructor

Properties

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsImpressionsQuery

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsImpressionsQuery

-

Optional limit

limit?: number

Number of returned impressions

+

Optional limit

limit?: number

Number of returned impressions

Memberof

AnalyticsImpressionsQuery

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructorendfilterslicenseKeylimitstart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorendfilterslicenseKeylimitstart
\ No newline at end of file diff --git a/docs/classes/AnalyticsImpressionsResponse.html b/docs/classes/AnalyticsImpressionsResponse.html index 70ef50041..1914d5abb 100644 --- a/docs/classes/AnalyticsImpressionsResponse.html +++ b/docs/classes/AnalyticsImpressionsResponse.html @@ -1,5 +1,5 @@ AnalyticsImpressionsResponse | @bitmovin/api-sdk

Class AnalyticsImpressionsResponse

Export

AnalyticsImpressionsResponse

-

Constructors

constructor +

Constructors

constructor

Properties

impressions? -

Constructors

constructor

Properties

Optional impressions

impressions?: AnalyticsImpressionListItem[]

Memberof

AnalyticsImpressionsResponse

-

Settings

Member Visibility

Theme

On This Page

constructorimpressions
\ No newline at end of file +

Constructors

constructor

Properties

Optional impressions

impressions?: AnalyticsImpressionListItem[]

Memberof

AnalyticsImpressionsResponse

+

Settings

Member Visibility

Theme

On This Page

constructorimpressions
\ No newline at end of file diff --git a/docs/classes/AnalyticsInFilter.html b/docs/classes/AnalyticsInFilter.html index 68287dd48..750100038 100644 --- a/docs/classes/AnalyticsInFilter.html +++ b/docs/classes/AnalyticsInFilter.html @@ -1,12 +1,12 @@ AnalyticsInFilter | @bitmovin/api-sdk

Class AnalyticsInFilter

Export

AnalyticsInFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.IN

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.IN

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsInFilter

-

Optional value

value?: any[]

Memberof

AnalyticsInFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any[]

Memberof

AnalyticsInFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsInsightsOrganizationSettings.html b/docs/classes/AnalyticsInsightsOrganizationSettings.html index 79f5d0244..a74985c01 100644 --- a/docs/classes/AnalyticsInsightsOrganizationSettings.html +++ b/docs/classes/AnalyticsInsightsOrganizationSettings.html @@ -1,18 +1,18 @@ AnalyticsInsightsOrganizationSettings | @bitmovin/api-sdk

Class AnalyticsInsightsOrganizationSettings

Export

AnalyticsInsightsOrganizationSettings

-

Constructors

constructor +

Constructors

constructor

Properties

includeInInsights? industry? isTrial? orgId? subIndustry? -

Constructors

constructor

Properties

Optional includeInInsights

includeInInsights?: boolean

Whether the organization's data is included in the industry insights

+

Constructors

constructor

Properties

Optional includeInInsights

includeInInsights?: boolean

Whether the organization's data is included in the industry insights

Memberof

AnalyticsInsightsOrganizationSettings

-

Optional industry

industry?: string

Industry of the organization

+

Optional industry

industry?: string

Industry of the organization

Memberof

AnalyticsInsightsOrganizationSettings

-

Optional isTrial

isTrial?: boolean

Whether the organization is on an analytics trial plan

+

Optional isTrial

isTrial?: boolean

Whether the organization is on an analytics trial plan

Memberof

AnalyticsInsightsOrganizationSettings

-

Optional orgId

orgId?: string

Organization ID

+

Optional orgId

orgId?: string

Organization ID

Memberof

AnalyticsInsightsOrganizationSettings

-

Optional subIndustry

subIndustry?: string

Subindustry of the organization

+

Optional subIndustry

subIndustry?: string

Subindustry of the organization

Memberof

AnalyticsInsightsOrganizationSettings

-

Settings

Member Visibility

Theme

On This Page

constructorincludeInInsightsindustryisTrialorgIdsubIndustry
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorincludeInInsightsindustryisTrialorgIdsubIndustry
\ No newline at end of file diff --git a/docs/classes/AnalyticsInsightsOrganizationSettingsRequest.html b/docs/classes/AnalyticsInsightsOrganizationSettingsRequest.html index 90a0333a4..fc2743644 100644 --- a/docs/classes/AnalyticsInsightsOrganizationSettingsRequest.html +++ b/docs/classes/AnalyticsInsightsOrganizationSettingsRequest.html @@ -1,6 +1,6 @@ AnalyticsInsightsOrganizationSettingsRequest | @bitmovin/api-sdk

Class AnalyticsInsightsOrganizationSettingsRequest

Export

AnalyticsInsightsOrganizationSettingsRequest

-

Constructors

constructor +

Constructors

constructor

Properties

includeInInsights? -

Constructors

constructor

Properties

Optional includeInInsights

includeInInsights?: boolean

Whether the organization's data is being contributed to industry insights

+

Constructors

constructor

Properties

Optional includeInInsights

includeInInsights?: boolean

Whether the organization's data is being contributed to industry insights

Memberof

AnalyticsInsightsOrganizationSettingsRequest

-

Settings

Member Visibility

Theme

On This Page

constructorincludeInInsights
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorincludeInInsights
\ No newline at end of file diff --git a/docs/classes/AnalyticsLessThanFilter.html b/docs/classes/AnalyticsLessThanFilter.html index b701211b0..2a0074e6a 100644 --- a/docs/classes/AnalyticsLessThanFilter.html +++ b/docs/classes/AnalyticsLessThanFilter.html @@ -1,12 +1,12 @@ AnalyticsLessThanFilter | @bitmovin/api-sdk

Class AnalyticsLessThanFilter

Export

AnalyticsLessThanFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.LT

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.LT

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsLessThanFilter

-

Optional value

value?: any

Memberof

AnalyticsLessThanFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AnalyticsLessThanFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsLessThanOrEqualFilter.html b/docs/classes/AnalyticsLessThanOrEqualFilter.html index 3eff33c34..68d1aa4a5 100644 --- a/docs/classes/AnalyticsLessThanOrEqualFilter.html +++ b/docs/classes/AnalyticsLessThanOrEqualFilter.html @@ -1,12 +1,12 @@ AnalyticsLessThanOrEqualFilter | @bitmovin/api-sdk

Class AnalyticsLessThanOrEqualFilter

Export

AnalyticsLessThanOrEqualFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.LTE

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.LTE

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsLessThanOrEqualFilter

-

Optional value

value?: any

Memberof

AnalyticsLessThanOrEqualFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AnalyticsLessThanOrEqualFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsLicense.html b/docs/classes/AnalyticsLicense.html index 6d7164d25..655d668a6 100644 --- a/docs/classes/AnalyticsLicense.html +++ b/docs/classes/AnalyticsLicense.html @@ -1,5 +1,5 @@ AnalyticsLicense | @bitmovin/api-sdk

Class AnalyticsLicense

Export

AnalyticsLicense

-

Constructors

constructor +

Constructors

constructor

Properties

compressedRetentionTime? createdAt? customData? @@ -21,45 +21,45 @@ retentionTime? subIndustry? timeZone? -

Constructors

constructor

Properties

Optional compressedRetentionTime

compressedRetentionTime?: string

Retention time for compressed data, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S

+

Constructors

constructor

Properties

Optional compressedRetentionTime

compressedRetentionTime?: string

Retention time for compressed data, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S

Memberof

AnalyticsLicense

-

Optional createdAt

createdAt?: Date

Creation date of the Analytics License, returned as ISO 8601 date-time format

+

Optional createdAt

createdAt?: Date

Creation date of the Analytics License, returned as ISO 8601 date-time format

Memberof

AnalyticsLicense

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

AnalyticsLicense

-

Optional customDataFieldLabels

customDataFieldLabels?: AnalyticsLicenseCustomDataFieldLabels

Labels for CustomData fields

+

Optional customDataFieldLabels

customDataFieldLabels?: AnalyticsLicenseCustomDataFieldLabels

Labels for CustomData fields

Memberof

AnalyticsLicense

-

Optional customDataFieldsCount

customDataFieldsCount?: number

The number of customData fields available

+

Optional customDataFieldsCount

customDataFieldsCount?: number

The number of customData fields available

Memberof

AnalyticsLicense

-

Optional domains

domains?: AnalyticsLicenseDomain[]

Whitelisted domains

+

Optional domains

domains?: AnalyticsLicenseDomain[]

Whitelisted domains

Memberof

AnalyticsLicense

-

Optional features

features?: AnalyticsLicenseFeatures

Memberof

AnalyticsLicense

-

Optional id

id?: string

Id of the Analytics License

+

Optional features

features?: AnalyticsLicenseFeatures

Memberof

AnalyticsLicense

+

Optional id

id?: string

Id of the Analytics License

Memberof

AnalyticsLicense

-

Optional ignoreDNT

ignoreDNT?: boolean

Whether the Do Not Track request from the browser should be ignored

+

Optional ignoreDNT

ignoreDNT?: boolean

Whether the Do Not Track request from the browser should be ignored

Memberof

AnalyticsLicense

-

Optional impressions

impressions?: number

Number of impressions recorded

+

Optional impressions

impressions?: number

Number of impressions recorded

Memberof

AnalyticsLicense

-

Optional includeInInsights

includeInInsights?: boolean

Whether the data of this license should be included in the industry insights or not

+

Optional includeInInsights

includeInInsights?: boolean

Whether the data of this license should be included in the industry insights or not

Memberof

AnalyticsLicense

-

Optional industry

industry?: string

The industry of the organization associated with the Analytics License

+

Optional industry

industry?: string

The industry of the organization associated with the Analytics License

Memberof

AnalyticsLicense

-

Optional licenseKey

licenseKey?: string

License Key

+

Optional licenseKey

licenseKey?: string

License Key

Memberof

AnalyticsLicense

-

Optional maxImpressions

maxImpressions?: number

Maximum number of impressions

+

Optional maxImpressions

maxImpressions?: number

Maximum number of impressions

Memberof

AnalyticsLicense

-

Optional name

name?: string

Name of the Analytics License

+

Optional name

name?: string

Name of the Analytics License

Memberof

AnalyticsLicense

-

Optional orderIndex

orderIndex?: number

Order index of license

+

Optional orderIndex

orderIndex?: number

Order index of license

Memberof

AnalyticsLicense

-

Optional planExpiredAt

planExpiredAt?: Date

The expiration date of the license if applicable, returned as ISO 8601 date-time format

+

Optional planExpiredAt

planExpiredAt?: Date

The expiration date of the license if applicable, returned as ISO 8601 date-time format

Memberof

AnalyticsLicense

-

Optional rateLimit

rateLimit?: string

The rate limit of this license

+

Optional rateLimit

rateLimit?: string

The rate limit of this license

Memberof

AnalyticsLicense

-

Optional retentionTime

retentionTime?: string

Retention time of impressions, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S

+

Optional retentionTime

retentionTime?: string

Retention time of impressions, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S

Memberof

AnalyticsLicense

-

Optional subIndustry

subIndustry?: string

The subindustry of the organization associated with the Analytics License

+

Optional subIndustry

subIndustry?: string

The subindustry of the organization associated with the Analytics License

Memberof

AnalyticsLicense

-

Optional timeZone

timeZone?: string

The timezone of the Analytics License

+

Optional timeZone

timeZone?: string

The timezone of the Analytics License

Memberof

AnalyticsLicense

-

Settings

Member Visibility

Theme

On This Page

constructorcompressedRetentionTimecreatedAtcustomDatacustomDataFieldLabelscustomDataFieldsCountdomainsfeaturesidignoreDNTimpressionsincludeInInsightsindustrylicenseKeymaxImpressionsnameorderIndexplanExpiredAtrateLimitretentionTimesubIndustrytimeZone
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcompressedRetentionTimecreatedAtcustomDatacustomDataFieldLabelscustomDataFieldsCountdomainsfeaturesidignoreDNTimpressionsincludeInInsightsindustrylicenseKeymaxImpressionsnameorderIndexplanExpiredAtrateLimitretentionTimesubIndustrytimeZone
\ No newline at end of file diff --git a/docs/classes/AnalyticsLicenseCustomDataFieldLabels.html b/docs/classes/AnalyticsLicenseCustomDataFieldLabels.html index 77054bb1a..fd5616b63 100644 --- a/docs/classes/AnalyticsLicenseCustomDataFieldLabels.html +++ b/docs/classes/AnalyticsLicenseCustomDataFieldLabels.html @@ -1,5 +1,5 @@ AnalyticsLicenseCustomDataFieldLabels | @bitmovin/api-sdk

Class AnalyticsLicenseCustomDataFieldLabels

Export

AnalyticsLicenseCustomDataFieldLabels

-

Constructors

constructor +

Constructors

constructor

Properties

customData1? customData10? customData11? @@ -30,64 +30,64 @@ customData7? customData8? customData9? -

Constructors

constructor

Properties

Optional customData1

customData1?: string

Label for field Custom Data 1

+

Constructors

constructor

Properties

Optional customData1

customData1?: string

Label for field Custom Data 1

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData10

customData10?: string

Label for field Custom Data 10

+

Optional customData10

customData10?: string

Label for field Custom Data 10

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData11

customData11?: string

Label for field Custom Data 11

+

Optional customData11

customData11?: string

Label for field Custom Data 11

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData12

customData12?: string

Label for field Custom Data 12

+

Optional customData12

customData12?: string

Label for field Custom Data 12

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData13

customData13?: string

Label for field Custom Data 13

+

Optional customData13

customData13?: string

Label for field Custom Data 13

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData14

customData14?: string

Label for field Custom Data 14

+

Optional customData14

customData14?: string

Label for field Custom Data 14

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData15

customData15?: string

Label for field Custom Data 15

+

Optional customData15

customData15?: string

Label for field Custom Data 15

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData16

customData16?: string

Label for field Custom Data 16

+

Optional customData16

customData16?: string

Label for field Custom Data 16

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData17

customData17?: string

Label for field Custom Data 17

+

Optional customData17

customData17?: string

Label for field Custom Data 17

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData18

customData18?: string

Label for field Custom Data 18

+

Optional customData18

customData18?: string

Label for field Custom Data 18

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData19

customData19?: string

Label for field Custom Data 19

+

Optional customData19

customData19?: string

Label for field Custom Data 19

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData2

customData2?: string

Label for field Custom Data 2

+

Optional customData2

customData2?: string

Label for field Custom Data 2

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData20

customData20?: string

Label for field Custom Data 20

+

Optional customData20

customData20?: string

Label for field Custom Data 20

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData21

customData21?: string

Label for field Custom Data 21

+

Optional customData21

customData21?: string

Label for field Custom Data 21

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData22

customData22?: string

Label for field Custom Data 22

+

Optional customData22

customData22?: string

Label for field Custom Data 22

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData23

customData23?: string

Label for field Custom Data 23

+

Optional customData23

customData23?: string

Label for field Custom Data 23

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData24

customData24?: string

Label for field Custom Data 24

+

Optional customData24

customData24?: string

Label for field Custom Data 24

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData25

customData25?: string

Label for field Custom Data 25

+

Optional customData25

customData25?: string

Label for field Custom Data 25

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData26

customData26?: string

Label for field Custom Data 26

+

Optional customData26

customData26?: string

Label for field Custom Data 26

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData27

customData27?: string

Label for field Custom Data 27

+

Optional customData27

customData27?: string

Label for field Custom Data 27

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData28

customData28?: string

Label for field Custom Data 28

+

Optional customData28

customData28?: string

Label for field Custom Data 28

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData29

customData29?: string

Label for field Custom Data 29

+

Optional customData29

customData29?: string

Label for field Custom Data 29

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData3

customData3?: string

Label for field Custom Data 3

+

Optional customData3

customData3?: string

Label for field Custom Data 3

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData30

customData30?: string

Label for field Custom Data 30

+

Optional customData30

customData30?: string

Label for field Custom Data 30

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData4

customData4?: string

Label for field Custom Data 4

+

Optional customData4

customData4?: string

Label for field Custom Data 4

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData5

customData5?: string

Label for field Custom Data 5

+

Optional customData5

customData5?: string

Label for field Custom Data 5

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData6

customData6?: string

Label for field Custom Data 6

+

Optional customData6

customData6?: string

Label for field Custom Data 6

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData7

customData7?: string

Label for field Custom Data 7

+

Optional customData7

customData7?: string

Label for field Custom Data 7

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData8

customData8?: string

Label for field Custom Data 8

+

Optional customData8

customData8?: string

Label for field Custom Data 8

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Optional customData9

customData9?: string

Label for field Custom Data 9

+

Optional customData9

customData9?: string

Label for field Custom Data 9

Memberof

AnalyticsLicenseCustomDataFieldLabels

-

Settings

Member Visibility

Theme

On This Page

constructorcustomData1customData10customData11customData12customData13customData14customData15customData16customData17customData18customData19customData2customData20customData21customData22customData23customData24customData25customData26customData27customData28customData29customData3customData30customData4customData5customData6customData7customData8customData9
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcustomData1customData10customData11customData12customData13customData14customData15customData16customData17customData18customData19customData2customData20customData21customData22customData23customData24customData25customData26customData27customData28customData29customData3customData30customData4customData5customData6customData7customData8customData9
\ No newline at end of file diff --git a/docs/classes/AnalyticsLicenseDomain.html b/docs/classes/AnalyticsLicenseDomain.html index e5ab9e667..90d331266 100644 --- a/docs/classes/AnalyticsLicenseDomain.html +++ b/docs/classes/AnalyticsLicenseDomain.html @@ -1,8 +1,8 @@ AnalyticsLicenseDomain | @bitmovin/api-sdk

Class AnalyticsLicenseDomain

Export

AnalyticsLicenseDomain

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? url? -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional url

url?: string

Memberof

AnalyticsLicenseDomain

-

Settings

Member Visibility

Theme

On This Page

constructoridurl
\ No newline at end of file +

Optional url

url?: string

Memberof

AnalyticsLicenseDomain

+

Settings

Member Visibility

Theme

On This Page

constructoridurl
\ No newline at end of file diff --git a/docs/classes/AnalyticsLicenseErrorDetailsConfig.html b/docs/classes/AnalyticsLicenseErrorDetailsConfig.html index 1719cd7b7..bad5c65d9 100644 --- a/docs/classes/AnalyticsLicenseErrorDetailsConfig.html +++ b/docs/classes/AnalyticsLicenseErrorDetailsConfig.html @@ -1,9 +1,9 @@ AnalyticsLicenseErrorDetailsConfig | @bitmovin/api-sdk

Class AnalyticsLicenseErrorDetailsConfig

Export

AnalyticsLicenseErrorDetailsConfig

-

Constructors

constructor +

Constructors

constructor

Properties

enabled? networkExplorerEnabled? -

Constructors

constructor

Properties

Optional enabled

enabled?: boolean

Are error details enabled on the license

+

Constructors

constructor

Properties

Optional enabled

enabled?: boolean

Are error details enabled on the license

Memberof

AnalyticsLicenseErrorDetailsConfig

-

Optional networkExplorerEnabled

networkExplorerEnabled?: boolean

Is network explorer feature enabled for the license

+

Optional networkExplorerEnabled

networkExplorerEnabled?: boolean

Is network explorer feature enabled for the license

Memberof

AnalyticsLicenseErrorDetailsConfig

-

Settings

Member Visibility

Theme

On This Page

constructorenablednetworkExplorerEnabled
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorenablednetworkExplorerEnabled
\ No newline at end of file diff --git a/docs/classes/AnalyticsLicenseFeatures.html b/docs/classes/AnalyticsLicenseFeatures.html index e0435008b..16a8cc19b 100644 --- a/docs/classes/AnalyticsLicenseFeatures.html +++ b/docs/classes/AnalyticsLicenseFeatures.html @@ -1,5 +1,5 @@ AnalyticsLicenseFeatures | @bitmovin/api-sdk

Class AnalyticsLicenseFeatures

Export

AnalyticsLicenseFeatures

-

Constructors

constructor +

Constructors

constructor

Properties

errorDetails? -

Constructors

constructor

Properties

Optional errorDetails

errorDetails?: AnalyticsLicenseErrorDetailsConfig

Memberof

AnalyticsLicenseFeatures

-

Settings

Member Visibility

Theme

On This Page

constructorerrorDetails
\ No newline at end of file +

Constructors

constructor

Properties

Optional errorDetails

errorDetails?: AnalyticsLicenseErrorDetailsConfig

Memberof

AnalyticsLicenseFeatures

+

Settings

Member Visibility

Theme

On This Page

constructorerrorDetails
\ No newline at end of file diff --git a/docs/classes/AnalyticsLicenseKey.html b/docs/classes/AnalyticsLicenseKey.html index 6a253cd8b..f51558cc6 100644 --- a/docs/classes/AnalyticsLicenseKey.html +++ b/docs/classes/AnalyticsLicenseKey.html @@ -1,6 +1,6 @@ AnalyticsLicenseKey | @bitmovin/api-sdk

Class AnalyticsLicenseKey

Export

AnalyticsLicenseKey

-

Constructors

constructor +

Constructors

constructor

Properties

licenseKey? -

Constructors

constructor

Properties

Optional licenseKey

licenseKey?: string

Analytics License Key (required)

+

Constructors

constructor

Properties

Optional licenseKey

licenseKey?: string

Analytics License Key (required)

Memberof

AnalyticsLicenseKey

-

Settings

Member Visibility

Theme

On This Page

constructorlicenseKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorlicenseKey
\ No newline at end of file diff --git a/docs/classes/AnalyticsMaxConcurrentViewersResponse.html b/docs/classes/AnalyticsMaxConcurrentViewersResponse.html index 0bbd2dd14..49327bbce 100644 --- a/docs/classes/AnalyticsMaxConcurrentViewersResponse.html +++ b/docs/classes/AnalyticsMaxConcurrentViewersResponse.html @@ -1,10 +1,10 @@ AnalyticsMaxConcurrentViewersResponse | @bitmovin/api-sdk

Class AnalyticsMaxConcurrentViewersResponse

Export

AnalyticsMaxConcurrentViewersResponse

-

Constructors

constructor +

Constructors

constructor

Properties

columnLabels? rowCount? rows? -

Constructors

constructor

Properties

Optional columnLabels

columnLabels?: AnalyticsColumnLabel[]

Memberof

AnalyticsMaxConcurrentViewersResponse

-

Optional rowCount

rowCount?: number

Number of rows returned

+

Constructors

constructor

Properties

Optional columnLabels

columnLabels?: AnalyticsColumnLabel[]

Memberof

AnalyticsMaxConcurrentViewersResponse

+

Optional rowCount

rowCount?: number

Number of rows returned

Memberof

AnalyticsMaxConcurrentViewersResponse

-

Optional rows

rows?: number[]

Memberof

AnalyticsMaxConcurrentViewersResponse

-

Settings

Member Visibility

Theme

On This Page

constructorcolumnLabelsrowCountrows
\ No newline at end of file +

Optional rows

rows?: number[]

Memberof

AnalyticsMaxConcurrentViewersResponse

+

Settings

Member Visibility

Theme

On This Page

constructorcolumnLabelsrowCountrows
\ No newline at end of file diff --git a/docs/classes/AnalyticsMaxQueryRequest.html b/docs/classes/AnalyticsMaxQueryRequest.html index 0c5e2d336..2c27a94f3 100644 --- a/docs/classes/AnalyticsMaxQueryRequest.html +++ b/docs/classes/AnalyticsMaxQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsMaxQueryRequest | @bitmovin/api-sdk

Class AnalyticsMaxQueryRequest

Export

AnalyticsMaxQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsMedianQueryRequest.html b/docs/classes/AnalyticsMedianQueryRequest.html index a250c3a00..1e5bf67b4 100644 --- a/docs/classes/AnalyticsMedianQueryRequest.html +++ b/docs/classes/AnalyticsMedianQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsMedianQueryRequest | @bitmovin/api-sdk

Class AnalyticsMedianQueryRequest

Export

AnalyticsMedianQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsMetricsQueryRequest.html b/docs/classes/AnalyticsMetricsQueryRequest.html index 979e86a83..9b1573b9c 100644 --- a/docs/classes/AnalyticsMetricsQueryRequest.html +++ b/docs/classes/AnalyticsMetricsQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsMetricsQueryRequest | @bitmovin/api-sdk

Class AnalyticsMetricsQueryRequest

Export

AnalyticsMetricsQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

end? filters? groupBy? @@ -9,18 +9,18 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Memberof

AnalyticsMetricsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsMetricsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsMetricsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Memberof

AnalyticsMetricsQueryRequest

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsMetricsQueryRequest

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsMetricsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsMetricsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsMetricsQueryRequest

-

Optional offset

offset?: number

Offset of data used for pagination

+

Optional offset

offset?: number

Offset of data used for pagination

Memberof

AnalyticsMetricsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsMetricsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsMetricsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructorendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorendfiltersgroupByintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsMinQueryRequest.html b/docs/classes/AnalyticsMinQueryRequest.html index b535f47fb..8cfbbae05 100644 --- a/docs/classes/AnalyticsMinQueryRequest.html +++ b/docs/classes/AnalyticsMinQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsMinQueryRequest | @bitmovin/api-sdk

Class AnalyticsMinQueryRequest

Export

AnalyticsMinQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsNotContainsFilter.html b/docs/classes/AnalyticsNotContainsFilter.html index d63df5627..0c8836a0b 100644 --- a/docs/classes/AnalyticsNotContainsFilter.html +++ b/docs/classes/AnalyticsNotContainsFilter.html @@ -1,12 +1,12 @@ AnalyticsNotContainsFilter | @bitmovin/api-sdk

Class AnalyticsNotContainsFilter

Export

AnalyticsNotContainsFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.NOTCONTAINS

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.NOTCONTAINS

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsNotContainsFilter

-

Optional value

value?: any

Memberof

AnalyticsNotContainsFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AnalyticsNotContainsFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsNotEqualFilter.html b/docs/classes/AnalyticsNotEqualFilter.html index 03447b9b5..e15265fe1 100644 --- a/docs/classes/AnalyticsNotEqualFilter.html +++ b/docs/classes/AnalyticsNotEqualFilter.html @@ -1,12 +1,12 @@ AnalyticsNotEqualFilter | @bitmovin/api-sdk

Class AnalyticsNotEqualFilter

Export

AnalyticsNotEqualFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name? operator value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

-

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.NE

Discriminator property for AnalyticsAbstractFilter

+

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsAbstractFilter

+

Readonly operator

operator: AnalyticsQueryOperator = AnalyticsQueryOperator.NE

Discriminator property for AnalyticsAbstractFilter

Memberof

AnalyticsNotEqualFilter

-

Optional value

value?: any

Memberof

AnalyticsNotEqualFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

  • CONTAINS: string
  • EQ: string
  • GT: string
  • GTE: string
  • IN: string
  • LT: string
  • LTE: string
  • NE: string
  • NOTCONTAINS: string

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional value

value?: any

Memberof

AnalyticsNotEqualFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CONTAINS: string;
    EQ: string;
    GT: string;
    GTE: string;
    IN: string;
    LT: string;
    LTE: string;
    NE: string;
    NOTCONTAINS: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "operator" = 'operator'

Settings

Member Visibility

Theme

On This Page

constructornameoperatorvalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsOrderByEntry.html b/docs/classes/AnalyticsOrderByEntry.html index 9204fc1d5..20b573476 100644 --- a/docs/classes/AnalyticsOrderByEntry.html +++ b/docs/classes/AnalyticsOrderByEntry.html @@ -1,7 +1,7 @@ AnalyticsOrderByEntry | @bitmovin/api-sdk

Class AnalyticsOrderByEntry

Export

AnalyticsOrderByEntry

-

Constructors

constructor +

Constructors

constructor

Properties

name? order? -

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsOrderByEntry

-

Optional order

order?: AnalyticsOrder

Memberof

AnalyticsOrderByEntry

-

Settings

Member Visibility

Theme

On This Page

constructornameorder
\ No newline at end of file +

Constructors

constructor

Properties

Optional name

name?: AnalyticsAttribute

Memberof

AnalyticsOrderByEntry

+

Optional order

order?: AnalyticsOrder

Memberof

AnalyticsOrderByEntry

+

Settings

Member Visibility

Theme

On This Page

constructornameorder
\ No newline at end of file diff --git a/docs/classes/AnalyticsOutput.html b/docs/classes/AnalyticsOutput.html index e476030fc..7aaac1775 100644 --- a/docs/classes/AnalyticsOutput.html +++ b/docs/classes/AnalyticsOutput.html @@ -1,5 +1,5 @@ AnalyticsOutput | @bitmovin/api-sdk

Class AnalyticsOutput

Export

AnalyticsOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -9,17 +9,17 @@ name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Memberof

AnalyticsOutput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Memberof

AnalyticsOutput

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AZURE: string;
    GCS_SERVICE_ACCOUNT: string;
    S3_ROLE_BASED: string;
} = ...

Type declaration

  • AZURE: string
  • GCS_SERVICE_ACCOUNT: string
  • S3_ROLE_BASED: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AZURE: string;
    GCS_SERVICE_ACCOUNT: string;
    S3_ROLE_BASED: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsPercentileQueryRequest.html b/docs/classes/AnalyticsPercentileQueryRequest.html index 2ebbab83b..ec43ad3c9 100644 --- a/docs/classes/AnalyticsPercentileQueryRequest.html +++ b/docs/classes/AnalyticsPercentileQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsPercentileQueryRequest | @bitmovin/api-sdk

Class AnalyticsPercentileQueryRequest

Export

AnalyticsPercentileQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -12,24 +12,24 @@ orderBy? percentile? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional percentile

percentile?: number

The percentage (0-99) used for percentile queries. (required)

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional percentile

percentile?: number

The percentage (0-99) used for percentile queries. (required)

Memberof

AnalyticsPercentileQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBypercentilestart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBypercentilestart
\ No newline at end of file diff --git a/docs/classes/AnalyticsQueryRequest.html b/docs/classes/AnalyticsQueryRequest.html index d25b79ff2..2ed22486e 100644 --- a/docs/classes/AnalyticsQueryRequest.html +++ b/docs/classes/AnalyticsQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsQueryRequest | @bitmovin/api-sdk

Class AnalyticsQueryRequest

Export

AnalyticsQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsQueryTimeframe.html b/docs/classes/AnalyticsQueryTimeframe.html index 4d63a7bda..62983b61a 100644 --- a/docs/classes/AnalyticsQueryTimeframe.html +++ b/docs/classes/AnalyticsQueryTimeframe.html @@ -1,9 +1,9 @@ AnalyticsQueryTimeframe | @bitmovin/api-sdk

Class AnalyticsQueryTimeframe

Export

AnalyticsQueryTimeframe

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

end? start? -

Constructors

constructor

Properties

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructorendstart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorendstart
\ No newline at end of file diff --git a/docs/classes/AnalyticsResponse.html b/docs/classes/AnalyticsResponse.html index bb6b6adb4..b322b8cff 100644 --- a/docs/classes/AnalyticsResponse.html +++ b/docs/classes/AnalyticsResponse.html @@ -1,12 +1,12 @@ AnalyticsResponse | @bitmovin/api-sdk

Class AnalyticsResponse

Export

AnalyticsResponse

-

Constructors

constructor +

Constructors

constructor

Properties

columnLabels? contextDescription? rowCount? rows? -

Constructors

constructor

Properties

Optional columnLabels

columnLabels?: AnalyticsColumnLabel[]

Memberof

AnalyticsResponse

-

Optional contextDescription

contextDescription?: AnalyticsContextDescription[]

Memberof

AnalyticsResponse

-

Optional rowCount

rowCount?: number

Number of rows returned

+

Constructors

constructor

Properties

Optional columnLabels

columnLabels?: AnalyticsColumnLabel[]

Memberof

AnalyticsResponse

+

Optional contextDescription

contextDescription?: AnalyticsContextDescription[]

Memberof

AnalyticsResponse

+

Optional rowCount

rowCount?: number

Number of rows returned

Memberof

AnalyticsResponse

-

Optional rows

rows?: any[]

Memberof

AnalyticsResponse

-

Settings

Member Visibility

Theme

On This Page

constructorcolumnLabelscontextDescriptionrowCountrows
\ No newline at end of file +

Optional rows

rows?: any[]

Memberof

AnalyticsResponse

+

Settings

Member Visibility

Theme

On This Page

constructorcolumnLabelscontextDescriptionrowCountrows
\ No newline at end of file diff --git a/docs/classes/AnalyticsS3RoleBasedOutput.html b/docs/classes/AnalyticsS3RoleBasedOutput.html index 719d0903c..1758f5f80 100644 --- a/docs/classes/AnalyticsS3RoleBasedOutput.html +++ b/docs/classes/AnalyticsS3RoleBasedOutput.html @@ -1,5 +1,5 @@ AnalyticsS3RoleBasedOutput | @bitmovin/api-sdk

Class AnalyticsS3RoleBasedOutput

Export

AnalyticsS3RoleBasedOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? bucketName? cloudRegion? @@ -17,31 +17,31 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Memberof

AnalyticsOutput

-

Optional bucketName

bucketName?: string

Amazon S3 bucket name (required)

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Memberof

AnalyticsOutput

+

Optional bucketName

bucketName?: string

Amazon S3 bucket name (required)

Memberof

AnalyticsS3RoleBasedOutput

-

Optional cloudRegion

cloudRegion?: AwsCloudRegion

Memberof

AnalyticsS3RoleBasedOutput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional cloudRegion

cloudRegion?: AwsCloudRegion

Memberof

AnalyticsS3RoleBasedOutput

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional externalId

externalId?: string

External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won't be able to write to the S3 bucket. An appropriate trust policy would look like this: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "{{externalId}}" is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the output configuration Bitmovin won't be able to write to the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new output, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

+

Optional externalId

externalId?: string

External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won't be able to write to the S3 bucket. An appropriate trust policy would look like this: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "{{externalId}}" is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the output configuration Bitmovin won't be able to write to the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new output, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

Memberof

AnalyticsS3RoleBasedOutput

-

Optional externalIdMode

externalIdMode?: ExternalIdMode

Memberof

AnalyticsS3RoleBasedOutput

-

Optional id

id?: string

Id of the resource (required)

+

Optional externalIdMode

externalIdMode?: ExternalIdMode

Memberof

AnalyticsS3RoleBasedOutput

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional md5MetaTag

md5MetaTag?: string

If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.

+

Optional md5MetaTag

md5MetaTag?: string

If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.

Memberof

AnalyticsS3RoleBasedOutput

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to write data to your S3 bucket. Please note that the IAM role has to have write access to S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)

+

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to write data to your S3 bucket. Please note that the IAM role has to have write access to S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)

Memberof

AnalyticsS3RoleBasedOutput

-

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication

+

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication

Memberof

AnalyticsS3RoleBasedOutput

-

Readonly type

type: AnalyticsOutputType = AnalyticsOutputType.S3_ROLE_BASED

Discriminator property for AnalyticsOutput

+

Readonly type

type: AnalyticsOutputType = AnalyticsOutputType.S3_ROLE_BASED

Discriminator property for AnalyticsOutput

Memberof

AnalyticsS3RoleBasedOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AZURE: string;
    GCS_SERVICE_ACCOUNT: string;
    S3_ROLE_BASED: string;
} = ...

Type declaration

  • AZURE: string
  • GCS_SERVICE_ACCOUNT: string
  • S3_ROLE_BASED: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclbucketNamecloudRegioncreatedAtcustomDatadescriptionexternalIdexternalIdModeidmd5MetaTagmodifiedAtnameroleArnsignatureVersiontype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AZURE: string;
    GCS_SERVICE_ACCOUNT: string;
    S3_ROLE_BASED: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclbucketNamecloudRegioncreatedAtcustomDatadescriptionexternalIdexternalIdModeidmd5MetaTagmodifiedAtnameroleArnsignatureVersiontype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AnalyticsStddevQueryRequest.html b/docs/classes/AnalyticsStddevQueryRequest.html index 86dbd28e9..4b9ee9286 100644 --- a/docs/classes/AnalyticsStddevQueryRequest.html +++ b/docs/classes/AnalyticsStddevQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsStddevQueryRequest | @bitmovin/api-sdk

Class AnalyticsStddevQueryRequest

Export

AnalyticsStddevQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsSumQueryRequest.html b/docs/classes/AnalyticsSumQueryRequest.html index a90e4fc2f..08958a282 100644 --- a/docs/classes/AnalyticsSumQueryRequest.html +++ b/docs/classes/AnalyticsSumQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsSumQueryRequest | @bitmovin/api-sdk

Class AnalyticsSumQueryRequest

Export

AnalyticsSumQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsVarianceQueryRequest.html b/docs/classes/AnalyticsVarianceQueryRequest.html index f44711e33..e591e23a9 100644 --- a/docs/classes/AnalyticsVarianceQueryRequest.html +++ b/docs/classes/AnalyticsVarianceQueryRequest.html @@ -1,5 +1,5 @@ AnalyticsVarianceQueryRequest | @bitmovin/api-sdk

Class AnalyticsVarianceQueryRequest

Export

AnalyticsVarianceQueryRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dimension? end? filters? @@ -11,22 +11,22 @@ offset? orderBy? start? -

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

-

Optional end

end?: Date

End of timeframe which is queried in UTC format.

+

Constructors

constructor

Properties

Optional dimension

dimension?: AnalyticsAttribute

Memberof

AnalyticsQueryRequest

+

Optional end

end?: Date

End of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

+

Optional filters

filters?: AnalyticsAbstractFilter[]

Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]

Memberof

AnalyticsQueryRequest

-

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

-

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

+

Optional groupBy

groupBy?: AnalyticsAttribute[]

Memberof

AnalyticsQueryRequest

+

Optional includeContext

includeContext?: boolean

Whether context data should be included in the response

Memberof

AnalyticsQueryRequest

-

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

-

Optional licenseKey

licenseKey?: string

Analytics license key (required)

+

Optional interval

interval?: AnalyticsInterval

Memberof

AnalyticsQueryRequest

+

Optional licenseKey

licenseKey?: string

Analytics license key (required)

Memberof

AnalyticsQueryRequest

-

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

+

Optional limit

limit?: number

Maximum number of rows returned (max. 200)

Memberof

AnalyticsQueryRequest

-

Optional offset

offset?: number

Offset of data

+

Optional offset

offset?: number

Offset of data

Memberof

AnalyticsQueryRequest

-

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

-

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

+

Optional orderBy

orderBy?: AnalyticsOrderByEntry[]

Memberof

AnalyticsQueryRequest

+

Optional start

start?: Date

Start of timeframe which is queried in UTC format.

Memberof

AnalyticsQueryTimeframe

-

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordimensionendfiltersgroupByincludeContextintervallicenseKeylimitoffsetorderBystart
\ No newline at end of file diff --git a/docs/classes/AnalyticsVirtualLicense.html b/docs/classes/AnalyticsVirtualLicense.html index fc8f8f52d..e2ff5f3ef 100644 --- a/docs/classes/AnalyticsVirtualLicense.html +++ b/docs/classes/AnalyticsVirtualLicense.html @@ -1,5 +1,5 @@ AnalyticsVirtualLicense | @bitmovin/api-sdk

Class AnalyticsVirtualLicense

Export

AnalyticsVirtualLicense

-

Constructors

constructor +

Constructors

constructor

Properties

compressedRetentionTime? customDataFieldLabels? customDataFieldsCount? @@ -9,22 +9,22 @@ planExpiredAt? retentionTime? timezone? -

Constructors

constructor

Properties

Optional compressedRetentionTime

compressedRetentionTime?: string

Retention time for compressed data, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S

+

Constructors

constructor

Properties

Optional compressedRetentionTime

compressedRetentionTime?: string

Retention time for compressed data, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S

Memberof

AnalyticsVirtualLicense

-

Optional customDataFieldLabels

customDataFieldLabels?: AnalyticsLicenseCustomDataFieldLabels

Labels for Custom Data fields

+

Optional customDataFieldLabels

customDataFieldLabels?: AnalyticsLicenseCustomDataFieldLabels

Labels for Custom Data fields

Memberof

AnalyticsVirtualLicense

-

Optional customDataFieldsCount

customDataFieldsCount?: number

The number of customData fields available

+

Optional customDataFieldsCount

customDataFieldsCount?: number

The number of customData fields available

Memberof

AnalyticsVirtualLicense

-

Optional id

id?: string

Analytics Virtual License Key/Id

+

Optional id

id?: string

Analytics Virtual License Key/Id

Memberof

AnalyticsVirtualLicense

-

Optional licenses

licenses?: AnalyticsVirtualLicenseLicensesListItem[]

List of Analytics Licenses

+

Optional licenses

licenses?: AnalyticsVirtualLicenseLicensesListItem[]

List of Analytics Licenses

Memberof

AnalyticsVirtualLicense

-

Optional name

name?: string

Name of the Analytics Virtual License

+

Optional name

name?: string

Name of the Analytics Virtual License

Memberof

AnalyticsVirtualLicense

-

Optional planExpiredAt

planExpiredAt?: Date

The expiration date of the license if applicable, returned as ISO 8601 date-time format

+

Optional planExpiredAt

planExpiredAt?: Date

The expiration date of the license if applicable, returned as ISO 8601 date-time format

Memberof

AnalyticsVirtualLicense

-

Optional retentionTime

retentionTime?: string

Retention time of impressions, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S

+

Optional retentionTime

retentionTime?: string

Retention time of impressions, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S

Memberof

AnalyticsVirtualLicense

-

Optional timezone

timezone?: string

The timezone of the Analytics Virtual License

+

Optional timezone

timezone?: string

The timezone of the Analytics Virtual License

Memberof

AnalyticsVirtualLicense

-

Settings

Member Visibility

Theme

On This Page

constructorcompressedRetentionTimecustomDataFieldLabelscustomDataFieldsCountidlicensesnameplanExpiredAtretentionTimetimezone
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcompressedRetentionTimecustomDataFieldLabelscustomDataFieldsCountidlicensesnameplanExpiredAtretentionTimetimezone
\ No newline at end of file diff --git a/docs/classes/AnalyticsVirtualLicenseLicensesListItem.html b/docs/classes/AnalyticsVirtualLicenseLicensesListItem.html index ce50f4ac3..593d90162 100644 --- a/docs/classes/AnalyticsVirtualLicenseLicensesListItem.html +++ b/docs/classes/AnalyticsVirtualLicenseLicensesListItem.html @@ -1,15 +1,15 @@ AnalyticsVirtualLicenseLicensesListItem | @bitmovin/api-sdk

Class AnalyticsVirtualLicenseLicensesListItem

Export

AnalyticsVirtualLicenseLicensesListItem

-

Constructors

constructor +

Constructors

constructor

Properties

id? licenseKey? name? orgId? -

Constructors

constructor

Properties

Optional id

id?: string

Analytics License Id

+

Constructors

constructor

Properties

Optional id

id?: string

Analytics License Id

Memberof

AnalyticsVirtualLicenseLicensesListItem

-

Optional licenseKey

licenseKey?: string

Analytics License key

+

Optional licenseKey

licenseKey?: string

Analytics License key

Memberof

AnalyticsVirtualLicenseLicensesListItem

-

Optional name

name?: string

Analytics License name

+

Optional name

name?: string

Analytics License name

Memberof

AnalyticsVirtualLicenseLicensesListItem

-

Optional orgId

orgId?: string

Organisation Id of license

+

Optional orgId

orgId?: string

Organisation Id of license

Memberof

AnalyticsVirtualLicenseLicensesListItem

-

Settings

Member Visibility

Theme

On This Page

constructoridlicenseKeynameorgId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridlicenseKeynameorgId
\ No newline at end of file diff --git a/docs/classes/AnalyticsVirtualLicenseRequest.html b/docs/classes/AnalyticsVirtualLicenseRequest.html index 0ebdc8a8f..0a34eda61 100644 --- a/docs/classes/AnalyticsVirtualLicenseRequest.html +++ b/docs/classes/AnalyticsVirtualLicenseRequest.html @@ -1,15 +1,15 @@ AnalyticsVirtualLicenseRequest | @bitmovin/api-sdk

Class AnalyticsVirtualLicenseRequest

Export

AnalyticsVirtualLicenseRequest

-

Constructors

constructor +

Constructors

constructor

Properties

customDataFieldLabels? licenses? name? timezone? -

Constructors

constructor

Properties

Optional customDataFieldLabels

customDataFieldLabels?: AnalyticsLicenseCustomDataFieldLabels

Labels for Custom Data fields

+

Constructors

constructor

Properties

Optional customDataFieldLabels

customDataFieldLabels?: AnalyticsLicenseCustomDataFieldLabels

Labels for Custom Data fields

Memberof

AnalyticsVirtualLicenseRequest

-

Optional licenses

licenses?: AnalyticsVirtualLicenseLicensesListItem[]

List of Analytics Licenses (required)

+

Optional licenses

licenses?: AnalyticsVirtualLicenseLicensesListItem[]

List of Analytics Licenses (required)

Memberof

AnalyticsVirtualLicenseRequest

-

Optional name

name?: string

Name of the Analytics Virtual License (required)

+

Optional name

name?: string

Name of the Analytics Virtual License (required)

Memberof

AnalyticsVirtualLicenseRequest

-

Optional timezone

timezone?: string

The timezone of the Analytics Virtual License (required)

+

Optional timezone

timezone?: string

The timezone of the Analytics Virtual License (required)

Memberof

AnalyticsVirtualLicenseRequest

-

Settings

Member Visibility

Theme

On This Page

constructorcustomDataFieldLabelslicensesnametimezone
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcustomDataFieldLabelslicensesnametimezone
\ No newline at end of file diff --git a/docs/classes/AndConjunction.html b/docs/classes/AndConjunction.html index 83dabcf22..bd4e5fe5e 100644 --- a/docs/classes/AndConjunction.html +++ b/docs/classes/AndConjunction.html @@ -1,11 +1,11 @@ AndConjunction | @bitmovin/api-sdk

Class AndConjunction

Export

AndConjunction

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

conditions? type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional conditions

conditions?: AbstractCondition[]

Array to perform the AND/OR evaluation on

+

Constructors

constructor

Properties

Optional conditions

conditions?: AbstractCondition[]

Array to perform the AND/OR evaluation on

Memberof

AbstractConjunction

-

Readonly type

type: ConditionType = ConditionType.AND

Discriminator property for AbstractCondition

+

Readonly type

type: ConditionType = ConditionType.AND

Discriminator property for AbstractCondition

Memberof

AndConjunction

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditionstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditionstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ApiErrorDefinition.html b/docs/classes/ApiErrorDefinition.html index 2f9ace595..c7f87718a 100644 --- a/docs/classes/ApiErrorDefinition.html +++ b/docs/classes/ApiErrorDefinition.html @@ -1,12 +1,12 @@ ApiErrorDefinition | @bitmovin/api-sdk

Class ApiErrorDefinition

Export

ApiErrorDefinition

-

Constructors

constructor +

Constructors

constructor

Properties

category? code? description? -

Constructors

constructor

Properties

Optional category

category?: string

The error category.

+

Constructors

constructor

Properties

Optional category

category?: string

The error category.

Memberof

ApiErrorDefinition

-

Optional code

code?: number

The error code.

+

Optional code

code?: number

The error code.

Memberof

ApiErrorDefinition

-

Optional description

description?: string

The returned error description.

+

Optional description

description?: string

The returned error description.

Memberof

ApiErrorDefinition

-

Settings

Member Visibility

Theme

On This Page

constructorcategorycodedescription
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcategorycodedescription
\ No newline at end of file diff --git a/docs/classes/AppliedStreamSettings.html b/docs/classes/AppliedStreamSettings.html index d882f1410..81b02eb4d 100644 --- a/docs/classes/AppliedStreamSettings.html +++ b/docs/classes/AppliedStreamSettings.html @@ -1,9 +1,9 @@ AppliedStreamSettings | @bitmovin/api-sdk

Class AppliedStreamSettings

Export

AppliedStreamSettings

-

Constructors

constructor +

Constructors

constructor

Properties

height? width? -

Constructors

constructor

Properties

Optional height

height?: number

The applied height. Useful if the height in the configuration was undefined

+

Constructors

constructor

Properties

Optional height

height?: number

The applied height. Useful if the height in the configuration was undefined

Memberof

AppliedStreamSettings

-

Optional width

width?: number

The applied width. Useful if the width in the configuration was undefined

+

Optional width

width?: number

The applied width. Useful if the width in the configuration was undefined

Memberof

AppliedStreamSettings

-

Settings

Member Visibility

Theme

On This Page

constructorheightwidth
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorheightwidth
\ No newline at end of file diff --git a/docs/classes/AsperaInput.html b/docs/classes/AsperaInput.html index 3944040ed..48abb1548 100644 --- a/docs/classes/AsperaInput.html +++ b/docs/classes/AsperaInput.html @@ -1,5 +1,5 @@ AsperaInput | @bitmovin/api-sdk

Class AsperaInput

Export

AsperaInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -17,34 +17,34 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional faspPort

faspPort?: number

Set the UDP port to be used by fasp for data transfer

+

Optional faspPort

faspPort?: number

Set the UDP port to be used by fasp for data transfer

Memberof

AsperaInput

-

Optional host

host?: string

Host to use for Aspera transfers (required)

+

Optional host

host?: string

Host to use for Aspera transfers (required)

Memberof

AsperaInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional maxBandwidth

maxBandwidth?: string

Maximal download bandwidth. Examples: 100k, 100m, 100g

+

Optional maxBandwidth

maxBandwidth?: string

Maximal download bandwidth. Examples: 100k, 100m, 100g

Memberof

AsperaInput

-

Optional minBandwidth

minBandwidth?: string

Minimal download bandwidth. Examples: 100k, 100m, 100g

+

Optional minBandwidth

minBandwidth?: string

Minimal download bandwidth. Examples: 100k, 100m, 100g

Memberof

AsperaInput

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional password

password?: string

corresponding password (either password and user must be set or token)

+

Optional password

password?: string

corresponding password (either password and user must be set or token)

Memberof

AsperaInput

-

Optional sshPort

sshPort?: number

Set the TCP port to be used for fasp session initiation

+

Optional sshPort

sshPort?: number

Set the TCP port to be used for fasp session initiation

Memberof

AsperaInput

-

Optional token

token?: string

Token used for authentication (either password and user must be set or token)

+

Optional token

token?: string

Token used for authentication (either password and user must be set or token)

Memberof

AsperaInput

-

Readonly type

type: InputType = InputType.ASPERA

Discriminator property for Input

+

Readonly type

type: InputType = InputType.ASPERA

Discriminator property for Input

Memberof

AsperaInput

-

Optional username

username?: string

Username to log into Aspera host (either password and user must be set or token)

+

Optional username

username?: string

Username to log into Aspera host (either password and user must be set or token)

Memberof

AsperaInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionfaspPorthostidmaxBandwidthminBandwidthmodifiedAtnamepasswordsshPorttokentypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionfaspPorthostidmaxBandwidthminBandwidthmodifiedAtnamepasswordsshPorttokentypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AudioAdaptationSet.html b/docs/classes/AudioAdaptationSet.html index 68acc0570..610418bdc 100644 --- a/docs/classes/AudioAdaptationSet.html +++ b/docs/classes/AudioAdaptationSet.html @@ -1,5 +1,5 @@ AudioAdaptationSet | @bitmovin/api-sdk

Class AudioAdaptationSet

Export

AudioAdaptationSet

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessibilities? customAttributes? id? @@ -9,18 +9,18 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

+

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

Memberof

AdaptationSet

-

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

+

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

Memberof

AdaptationSet

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional labels

labels?: Label[]

List of labels

+

Optional labels

labels?: Label[]

List of labels

Memberof

AdaptationSet

-

Optional lang

lang?: string

ISO 639-1 (Alpha-2) code identifying the language of the audio adaptation set (required)

+

Optional lang

lang?: string

ISO 639-1 (Alpha-2) code identifying the language of the audio adaptation set (required)

Memberof

AudioAdaptationSet

-

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

+

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

Memberof

AdaptationSet

-

Readonly type

type: AdaptationSetType = AdaptationSetType.AUDIO

Discriminator property for AdaptationSet

+

Readonly type

type: AdaptationSetType = AdaptationSetType.AUDIO

Discriminator property for AdaptationSet

Memberof

AudioAdaptationSet

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

  • AUDIO: string
  • IMAGE: string
  • SUBTITLE: string
  • VIDEO: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelslangrolestype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelslangrolestype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AudioConfiguration.html b/docs/classes/AudioConfiguration.html index 86b1e1cb3..e3accfc48 100644 --- a/docs/classes/AudioConfiguration.html +++ b/docs/classes/AudioConfiguration.html @@ -1,5 +1,5 @@ AudioConfiguration | @bitmovin/api-sdk

Class AudioConfiguration

Export

AudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? createdAt? customData? @@ -10,20 +10,20 @@ rate? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecreatedAtcustomDatadescriptionidmodifiedAtnamerate_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecreatedAtcustomDatadescriptionidmodifiedAtnamerate_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AudioGroup.html b/docs/classes/AudioGroup.html index 57c7e8dd3..7ca1f711e 100644 --- a/docs/classes/AudioGroup.html +++ b/docs/classes/AudioGroup.html @@ -1,9 +1,9 @@ AudioGroup | @bitmovin/api-sdk

Class AudioGroup

Export

AudioGroup

-

Constructors

constructor +

Constructors

constructor

Properties

name? priority? -

Constructors

constructor

Properties

Optional name

name?: string

Name of the audio group (required)

+

Constructors

constructor

Properties

Optional name

name?: string

Name of the audio group (required)

Memberof

AudioGroup

-

Optional priority

priority?: number

Priority of the audio group (required)

+

Optional priority

priority?: number

Priority of the audio group (required)

Memberof

AudioGroup

-

Settings

Member Visibility

Theme

On This Page

constructornamepriority
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructornamepriority
\ No newline at end of file diff --git a/docs/classes/AudioGroupConfiguration.html b/docs/classes/AudioGroupConfiguration.html index 1ba853b61..e697e4262 100644 --- a/docs/classes/AudioGroupConfiguration.html +++ b/docs/classes/AudioGroupConfiguration.html @@ -1,9 +1,9 @@ AudioGroupConfiguration | @bitmovin/api-sdk

Class AudioGroupConfiguration

Export

AudioGroupConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

droppingMode? groups? -

Constructors

constructor

Properties

Optional droppingMode

droppingMode?: VariantStreamDroppingMode

Dropping mode (required)

+

Constructors

constructor

Properties

Optional droppingMode

droppingMode?: VariantStreamDroppingMode

Dropping mode (required)

Memberof

AudioGroupConfiguration

-

Optional groups

groups?: AudioGroup[]

Audio groups (required)

+

Optional groups

groups?: AudioGroup[]

Audio groups (required)

Memberof

AudioGroupConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructordroppingModegroups
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordroppingModegroups
\ No newline at end of file diff --git a/docs/classes/AudioMediaInfo.html b/docs/classes/AudioMediaInfo.html index 6ed76c79a..6da7b9d19 100644 --- a/docs/classes/AudioMediaInfo.html +++ b/docs/classes/AudioMediaInfo.html @@ -1,5 +1,5 @@ AudioMediaInfo | @bitmovin/api-sdk

Class AudioMediaInfo

Export

AudioMediaInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assocLanguage? autoselect? characteristics? @@ -17,38 +17,38 @@ startSegmentNumber? streamId? uri? -

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

+

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

Memberof

BasicMediaInfo

-

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

+

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

Memberof

BasicMediaInfo

-

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

+

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

Memberof

BasicMediaInfo

-

Optional drmId

drmId?: string

Id of the DRM.

+

Optional drmId

drmId?: string

Id of the DRM.

Memberof

SegmentsMediaInfo

-

Optional encodingId

encodingId?: string

Id of the encoding. (required)

+

Optional encodingId

encodingId?: string

Id of the encoding. (required)

Memberof

SegmentsMediaInfo

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

Memberof

SegmentsMediaInfo

-

Optional forced

forced?: boolean

A value of true indicates that the Rendition contains content which is considered essential to play.

+

Optional forced

forced?: boolean

A value of true indicates that the Rendition contains content which is considered essential to play.

Memberof

AudioMediaInfo

-

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

+

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

Memberof

BasicMediaInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

+

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

Memberof

BasicMediaInfo

-

Optional language

language?: string

Primary language in the rendition.

+

Optional language

language?: string

Primary language in the rendition.

Memberof

BasicMediaInfo

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

SegmentsMediaInfo

-

Optional name

name?: string

Human readable description of the rendition. (required)

+

Optional name

name?: string

Human readable description of the rendition. (required)

Memberof

BasicMediaInfo

-

Optional segmentPath

segmentPath?: string

Path to segments. (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. (required)

Memberof

SegmentsMediaInfo

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

Memberof

SegmentsMediaInfo

-

Optional streamId

streamId?: string

Id of the stream. (required)

+

Optional streamId

streamId?: string

Id of the stream. (required)

Memberof

SegmentsMediaInfo

-

Optional uri

uri?: string

The URI of the Rendition (required)

+

Optional uri

uri?: string

The URI of the Rendition (required)

Memberof

StandardMediaInfo

-

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumberforcedgroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamIduri
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumberforcedgroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamIduri
\ No newline at end of file diff --git a/docs/classes/AudioMixChannel.html b/docs/classes/AudioMixChannel.html index 6db2ecb84..bffaa710a 100644 --- a/docs/classes/AudioMixChannel.html +++ b/docs/classes/AudioMixChannel.html @@ -1,9 +1,9 @@ AudioMixChannel | @bitmovin/api-sdk

Class AudioMixChannel

Export

AudioMixChannel

-

Constructors

constructor +

Constructors

constructor

Properties

channelNumber? sourceChannels? -

Constructors

constructor

Properties

Optional channelNumber

channelNumber?: number

Channel number of this mix (starting with 0) (required)

+

Constructors

constructor

Properties

Optional channelNumber

channelNumber?: number

Channel number of this mix (starting with 0) (required)

Memberof

AudioMixChannel

-

Optional sourceChannels

sourceChannels?: SourceChannel[]

List of source channels to be mixed (required)

+

Optional sourceChannels

sourceChannels?: SourceChannel[]

List of source channels to be mixed (required)

Memberof

AudioMixChannel

-

Settings

Member Visibility

Theme

On This Page

constructorchannelNumbersourceChannels
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorchannelNumbersourceChannels
\ No newline at end of file diff --git a/docs/classes/AudioMixFilter.html b/docs/classes/AudioMixFilter.html index 0216f81ee..135368759 100644 --- a/docs/classes/AudioMixFilter.html +++ b/docs/classes/AudioMixFilter.html @@ -1,5 +1,5 @@ AudioMixFilter | @bitmovin/api-sdk

Class AudioMixFilter

Export

AudioMixFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioMixChannels? channelLayout? createdAt? @@ -11,22 +11,22 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional audioMixChannels

audioMixChannels?: AudioMixChannel[]

List of mixed channels that matches the channel layout (required)

+

Constructors

constructor

Properties

Optional audioMixChannels

audioMixChannels?: AudioMixChannel[]

List of mixed channels that matches the channel layout (required)

Memberof

AudioMixFilter

-

Optional channelLayout

channelLayout?: AudioMixChannelLayout

Channel layout of the audio codec configuration (required)

+

Optional channelLayout

channelLayout?: AudioMixChannelLayout

Channel layout of the audio codec configuration (required)

Memberof

AudioMixFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: FilterType = FilterType.AUDIO_MIX

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.AUDIO_MIX

Discriminator property for Filter

Memberof

AudioMixFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraudioMixChannelschannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraudioMixChannelschannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AudioMixInputStream.html b/docs/classes/AudioMixInputStream.html index 5c7740e98..29cf7504d 100644 --- a/docs/classes/AudioMixInputStream.html +++ b/docs/classes/AudioMixInputStream.html @@ -1,5 +1,5 @@ AudioMixInputStream | @bitmovin/api-sdk

Class AudioMixInputStream

Export

AudioMixInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioMixChannels? channelLayout? createdAt? @@ -11,21 +11,21 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional audioMixChannels

audioMixChannels?: AudioMixInputStreamChannel[]

Memberof

AudioMixInputStream

-

Optional channelLayout

channelLayout?: AudioMixInputChannelLayout

Channel layout of the audio mix input stream

+

Constructors

constructor

Properties

Optional audioMixChannels

audioMixChannels?: AudioMixInputStreamChannel[]

Memberof

AudioMixInputStream

+

Optional channelLayout

channelLayout?: AudioMixInputChannelLayout

Channel layout of the audio mix input stream

Memberof

AudioMixInputStream

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputStreamType = InputStreamType.AUDIO_MIX

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.AUDIO_MIX

Discriminator property for InputStream

Memberof

AudioMixInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraudioMixChannelschannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraudioMixChannelschannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AudioMixInputStreamChannel.html b/docs/classes/AudioMixInputStreamChannel.html index 8bd595310..49753670a 100644 --- a/docs/classes/AudioMixInputStreamChannel.html +++ b/docs/classes/AudioMixInputStreamChannel.html @@ -1,14 +1,14 @@ AudioMixInputStreamChannel | @bitmovin/api-sdk

Class AudioMixInputStreamChannel

Export

AudioMixInputStreamChannel

-

Constructors

constructor +

Constructors

constructor

Properties

inputStreamId? outputChannelNumber? outputChannelType? sourceChannels? -

Constructors

constructor

Properties

Optional inputStreamId

inputStreamId?: string

The id of the input stream that should be used for mixing.

+

Constructors

constructor

Properties

Optional inputStreamId

inputStreamId?: string

The id of the input stream that should be used for mixing.

Memberof

AudioMixInputStreamChannel

-

Optional outputChannelNumber

outputChannelNumber?: number

Number of this output channel. If type is 'CHANNEL_NUMBER', this must be set.

+

Optional outputChannelNumber

outputChannelNumber?: number

Number of this output channel. If type is 'CHANNEL_NUMBER', this must be set.

Memberof

AudioMixInputStreamChannel

-

Optional outputChannelType

outputChannelType?: AudioMixChannelType

Memberof

AudioMixInputStreamChannel

-

Optional sourceChannels

sourceChannels?: AudioMixInputStreamSourceChannel[]

List of source channels to be mixed

+

Optional outputChannelType

outputChannelType?: AudioMixChannelType

Memberof

AudioMixInputStreamChannel

+

Optional sourceChannels

sourceChannels?: AudioMixInputStreamSourceChannel[]

List of source channels to be mixed

Memberof

AudioMixInputStreamChannel

-

Settings

Member Visibility

Theme

On This Page

constructorinputStreamIdoutputChannelNumberoutputChannelTypesourceChannels
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorinputStreamIdoutputChannelNumberoutputChannelTypesourceChannels
\ No newline at end of file diff --git a/docs/classes/AudioMixInputStreamSourceChannel.html b/docs/classes/AudioMixInputStreamSourceChannel.html index 8e5d51622..13d2b4efe 100644 --- a/docs/classes/AudioMixInputStreamSourceChannel.html +++ b/docs/classes/AudioMixInputStreamSourceChannel.html @@ -1,11 +1,11 @@ AudioMixInputStreamSourceChannel | @bitmovin/api-sdk

Class AudioMixInputStreamSourceChannel

Export

AudioMixInputStreamSourceChannel

-

Constructors

constructor +

Constructors

constructor

Properties

channelNumber? gain? type? -

Constructors

constructor

Properties

Optional channelNumber

channelNumber?: number

Number of this source channel. If type is 'CHANNEL_NUMBER', this must be set.

+

Constructors

constructor

Properties

Optional channelNumber

channelNumber?: number

Number of this source channel. If type is 'CHANNEL_NUMBER', this must be set.

Memberof

AudioMixInputStreamSourceChannel

-

Optional gain

gain?: number

Gain for this source channel. Default is 1.0.

+

Optional gain

gain?: number

Gain for this source channel. Default is 1.0.

Memberof

AudioMixInputStreamSourceChannel

-

Optional type

type?: AudioMixSourceChannelType

Memberof

AudioMixInputStreamSourceChannel

-

Settings

Member Visibility

Theme

On This Page

constructorchannelNumbergaintype
\ No newline at end of file +

Optional type

type?: AudioMixSourceChannelType

Memberof

AudioMixInputStreamSourceChannel

+

Settings

Member Visibility

Theme

On This Page

constructorchannelNumbergaintype
\ No newline at end of file diff --git a/docs/classes/AudioStream.html b/docs/classes/AudioStream.html index d2eb0c950..09b4bb7c9 100644 --- a/docs/classes/AudioStream.html +++ b/docs/classes/AudioStream.html @@ -1,5 +1,5 @@ AudioStream | @bitmovin/api-sdk

Class AudioStream

Export

AudioStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelFormat? codec? @@ -10,24 +10,24 @@ position? rate? sampleRate? -

Constructors

constructor

Properties

Optional bitrate

bitrate?: string

Bitrate in bps

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: string

Bitrate in bps

Memberof

AudioStream

-

Optional channelFormat

channelFormat?: string

Audio channel format

+

Optional channelFormat

channelFormat?: string

Audio channel format

Memberof

AudioStream

-

Optional codec

codec?: string

Codec of the stream

+

Optional codec

codec?: string

Codec of the stream

Memberof

MediaStream

-

Optional duration

duration?: number

Duration of the stream in seconds

+

Optional duration

duration?: number

Duration of the stream in seconds

Memberof

MediaStream

-

Optional hearingImpaired

hearingImpaired?: boolean

Hearing impaired support

+

Optional hearingImpaired

hearingImpaired?: boolean

Hearing impaired support

Memberof

AudioStream

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional language

language?: string

Language of the stream

+

Optional language

language?: string

Language of the stream

Memberof

AudioStream

-

Optional position

position?: number

Position of the stream in the media, starting from 0.

+

Optional position

position?: number

Position of the stream in the media, starting from 0.

Memberof

MediaStream

-

Optional rate

rate?: number

Bitrate in bps

+

Optional rate

rate?: number

Bitrate in bps

Memberof

AudioStream

-

Optional sampleRate

sampleRate?: number

Audio sampling rate in Hz

+

Optional sampleRate

sampleRate?: number

Audio sampling rate in Hz

Memberof

AudioStream

-

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelFormatcodecdurationhearingImpairedidlanguagepositionratesampleRate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelFormatcodecdurationhearingImpairedidlanguagepositionratesampleRate
\ No newline at end of file diff --git a/docs/classes/AudioVolumeFilter.html b/docs/classes/AudioVolumeFilter.html index 63b93900a..3885d655e 100644 --- a/docs/classes/AudioVolumeFilter.html +++ b/docs/classes/AudioVolumeFilter.html @@ -1,5 +1,5 @@ AudioVolumeFilter | @bitmovin/api-sdk

Class AudioVolumeFilter

Export

AudioVolumeFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,22 +12,22 @@ volume? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional format

format?: AudioVolumeFormat

Memberof

AudioVolumeFilter

-

Optional id

id?: string

Id of the resource (required)

+

Optional format

format?: AudioVolumeFormat

Memberof

AudioVolumeFilter

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: FilterType = FilterType.AUDIO_VOLUME

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.AUDIO_VOLUME

Discriminator property for Filter

Memberof

AudioVolumeFilter

-

Optional unit

unit?: AudioVolumeUnit

Memberof

AudioVolumeFilter

-

Optional volume

volume?: number

Audio volume value (required)

+

Optional unit

unit?: AudioVolumeUnit

Memberof

AudioVolumeFilter

+

Optional volume

volume?: number

Audio volume value (required)

Memberof

AudioVolumeFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionformatidmodifiedAtnametypeunitvolume_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionformatidmodifiedAtnametypeunitvolume_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AutoRepresentation.html b/docs/classes/AutoRepresentation.html index 19817708c..134e34e3b 100644 --- a/docs/classes/AutoRepresentation.html +++ b/docs/classes/AutoRepresentation.html @@ -1,6 +1,6 @@ AutoRepresentation | @bitmovin/api-sdk

Class AutoRepresentation

Export

AutoRepresentation

-

Constructors

constructor +

Constructors

constructor

Properties

adoptConfigurationThreshold? -

Constructors

constructor

Properties

Optional adoptConfigurationThreshold

adoptConfigurationThreshold?: number

This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.

+

Constructors

constructor

Properties

Optional adoptConfigurationThreshold

adoptConfigurationThreshold?: number

This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.

Memberof

AutoRepresentation

-

Settings

Member Visibility

Theme

On This Page

constructoradoptConfigurationThreshold
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoradoptConfigurationThreshold
\ No newline at end of file diff --git a/docs/classes/AutoRestartConfiguration.html b/docs/classes/AutoRestartConfiguration.html index 6d2fc538e..9aa95f715 100644 --- a/docs/classes/AutoRestartConfiguration.html +++ b/docs/classes/AutoRestartConfiguration.html @@ -1,5 +1,5 @@ AutoRestartConfiguration | @bitmovin/api-sdk

Class AutoRestartConfiguration

Export

AutoRestartConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

bytesWrittenTimeout? dashManifestsUpdateTimeout? framesWrittenTimeout? @@ -7,18 +7,18 @@ restartOnEncoderError? scheduleExpression? segmentsWrittenTimeout? -

Constructors

constructor

Properties

Optional bytesWrittenTimeout

bytesWrittenTimeout?: number

If no data was written for the given number of seconds, a restart is triggered. Minimum: 30.0

+

Constructors

constructor

Properties

Optional bytesWrittenTimeout

bytesWrittenTimeout?: number

If no data was written for the given number of seconds, a restart is triggered. Minimum: 30.0

Memberof

AutoRestartConfiguration

-

Optional dashManifestsUpdateTimeout

dashManifestsUpdateTimeout?: number

If DASH manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0

+

Optional dashManifestsUpdateTimeout

dashManifestsUpdateTimeout?: number

If DASH manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0

Memberof

AutoRestartConfiguration

-

Optional framesWrittenTimeout

framesWrittenTimeout?: number

If no frames were generated for the given number of seconds, a restart is triggered. Minimum: 30.0

+

Optional framesWrittenTimeout

framesWrittenTimeout?: number

If no frames were generated for the given number of seconds, a restart is triggered. Minimum: 30.0

Memberof

AutoRestartConfiguration

-

Optional hlsManifestsUpdateTimeout

hlsManifestsUpdateTimeout?: number

If HLS manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0

+

Optional hlsManifestsUpdateTimeout

hlsManifestsUpdateTimeout?: number

If HLS manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0

Memberof

AutoRestartConfiguration

-

Optional restartOnEncoderError

restartOnEncoderError?: boolean

Defines if the encoding should be restarted in case of an error during encoding.

+

Optional restartOnEncoderError

restartOnEncoderError?: boolean

Defines if the encoding should be restarted in case of an error during encoding.

Memberof

AutoRestartConfiguration

-

Optional scheduleExpression

scheduleExpression?: string

Defines a schedule for restarts using the unix crontab syntax. This example would trigger a restart every monday at 05:30 (AM)

+

Optional scheduleExpression

scheduleExpression?: string

Defines a schedule for restarts using the unix crontab syntax. This example would trigger a restart every monday at 05:30 (AM)

Memberof

AutoRestartConfiguration

-

Optional segmentsWrittenTimeout

segmentsWrittenTimeout?: number

If no segments were generated for the given number of seconds, a restart is triggered. Minimum: 30.0

+

Optional segmentsWrittenTimeout

segmentsWrittenTimeout?: number

If no segments were generated for the given number of seconds, a restart is triggered. Minimum: 30.0

Memberof

AutoRestartConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorbytesWrittenTimeoutdashManifestsUpdateTimeoutframesWrittenTimeouthlsManifestsUpdateTimeoutrestartOnEncoderErrorscheduleExpressionsegmentsWrittenTimeout
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbytesWrittenTimeoutdashManifestsUpdateTimeoutframesWrittenTimeouthlsManifestsUpdateTimeoutrestartOnEncoderErrorscheduleExpressionsegmentsWrittenTimeout
\ No newline at end of file diff --git a/docs/classes/Av1PerTitleConfiguration.html b/docs/classes/Av1PerTitleConfiguration.html index 93c076ae8..54b17cf28 100644 --- a/docs/classes/Av1PerTitleConfiguration.html +++ b/docs/classes/Av1PerTitleConfiguration.html @@ -1,5 +1,5 @@ Av1PerTitleConfiguration | @bitmovin/api-sdk

Class Av1PerTitleConfiguration

Export

Av1PerTitleConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoRepresentations? complexityFactor? fixedResolutionAndBitrateConfiguration? @@ -8,19 +8,19 @@ minBitrate? minBitrateStepSize? targetQualityCrf? -

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

-

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

+

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

+

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

Memberof

PerTitleConfiguration

-

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

+

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

Memberof

PerTitleConfiguration

-

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

+

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

Memberof

PerTitleConfiguration

-

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

+

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

Memberof

PerTitleConfiguration

-

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

+

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

Memberof

PerTitleConfiguration

-

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

+

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

Memberof

PerTitleConfiguration

-

Optional targetQualityCrf

targetQualityCrf?: number

Desired target quality of the highest representation expressed as CRF value

+

Optional targetQualityCrf

targetQualityCrf?: number

Desired target quality of the highest representation expressed as CRF value

Memberof

Av1PerTitleConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSizetargetQualityCrf
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSizetargetQualityCrf
\ No newline at end of file diff --git a/docs/classes/Av1VideoConfiguration.html b/docs/classes/Av1VideoConfiguration.html index 40cef45a4..7100ccb76 100644 --- a/docs/classes/Av1VideoConfiguration.html +++ b/docs/classes/Av1VideoConfiguration.html @@ -1,5 +1,5 @@ Av1VideoConfiguration | @bitmovin/api-sdk

Class Av1VideoConfiguration

Export

Av1VideoConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoLevelSetup? bitrate? colorConfig? @@ -21,41 +21,41 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.

+

Constructors

constructor

Properties

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.

Memberof

Av1VideoConfiguration

-

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

+

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Memberof

VideoConfiguration

-

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

+

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Memberof

VideoConfiguration

-

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

+

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

Memberof

VideoConfiguration

-

Optional height

height?: number

Height of the encoded video in pixels

+

Optional height

height?: number

Height of the encoded video in pixels

Memberof

VideoConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

+

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Memberof

VideoConfiguration

-

Optional presetConfiguration

presetConfiguration?: Av1PresetConfiguration

Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.

+

Optional presetConfiguration

presetConfiguration?: Av1PresetConfiguration

Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.

Memberof

Av1VideoConfiguration

-

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

+

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

Memberof

VideoConfiguration

-

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.AV1

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.AV1

Discriminator property for CodecConfiguration

Memberof

Av1VideoConfiguration

-

Optional width

width?: number

Width of the encoded video in pixels

+

Optional width

width?: number

Width of the encoded video in pixels

Memberof

VideoConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorautoLevelSetupbitratecolorConfigcreatedAtcustomDatadescriptiondisplayAspectRatioencodingModeheightidmodifiedAtnamepixelFormatpresetConfigurationratesampleAspectRatioDenominatorsampleAspectRatioNumeratortypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorautoLevelSetupbitratecolorConfigcreatedAtcustomDatadescriptiondisplayAspectRatioencodingModeheightidmodifiedAtnamepixelFormatpresetConfigurationratesampleAspectRatioDenominatorsampleAspectRatioNumeratortypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AwsAccount.html b/docs/classes/AwsAccount.html index 78069bc1a..d325977b0 100644 --- a/docs/classes/AwsAccount.html +++ b/docs/classes/AwsAccount.html @@ -1,5 +1,5 @@ AwsAccount | @bitmovin/api-sdk

Class AwsAccount

Export

AwsAccount

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? accountNumber? createdAt? @@ -9,22 +9,22 @@ modifiedAt? name? secretKey? -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Amazon access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Amazon access key (required)

Memberof

AwsAccount

-

Optional accountNumber

accountNumber?: string

Amazon account number (12 digits as per AWS spec) (required)

+

Optional accountNumber

accountNumber?: string

Amazon account number (12 digits as per AWS spec) (required)

Memberof

AwsAccount

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional secretKey

secretKey?: string

Amazon secret key (required)

+

Optional secretKey

secretKey?: string

Amazon secret key (required)

Memberof

AwsAccount

-

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaccountNumbercreatedAtcustomDatadescriptionidmodifiedAtnamesecretKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaccountNumbercreatedAtcustomDatadescriptionidmodifiedAtnamesecretKey
\ No newline at end of file diff --git a/docs/classes/AwsAccountRegionSettings.html b/docs/classes/AwsAccountRegionSettings.html index 9aadfdee8..19ae1340a 100644 --- a/docs/classes/AwsAccountRegionSettings.html +++ b/docs/classes/AwsAccountRegionSettings.html @@ -1,5 +1,5 @@ AwsAccountRegionSettings | @bitmovin/api-sdk

Class AwsAccountRegionSettings

Export

AwsAccountRegionSettings

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -11,25 +11,25 @@ securityGroupId? sshPort? subnetId? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional limitParallelEncodings

limitParallelEncodings?: number

Limit for the amount of running encodings at a time. Leave empty for no limit.

+

Optional limitParallelEncodings

limitParallelEncodings?: number

Limit for the amount of running encodings at a time. Leave empty for no limit.

Memberof

AwsAccountRegionSettings

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional region

region?: AwsCloudRegion

Memberof

AwsAccountRegionSettings

-

Optional securityGroupId

securityGroupId?: string

Id of the security group for encoding instances (required)

+

Optional region

region?: AwsCloudRegion

Memberof

AwsAccountRegionSettings

+

Optional securityGroupId

securityGroupId?: string

Id of the security group for encoding instances (required)

Memberof

AwsAccountRegionSettings

-

Optional sshPort

sshPort?: number

Custom SSH port. Valid values: 1 - 65535. Leave empty if the default SSH port 22 is OK.

+

Optional sshPort

sshPort?: number

Custom SSH port. Valid values: 1 - 65535. Leave empty if the default SSH port 22 is OK.

Memberof

AwsAccountRegionSettings

-

Optional subnetId

subnetId?: string

Id of the subnet for encoding instances (required)

+

Optional subnetId

subnetId?: string

Id of the subnet for encoding instances (required)

Memberof

AwsAccountRegionSettings

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidlimitParallelEncodingsmodifiedAtnameregionsecurityGroupIdsshPortsubnetId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidlimitParallelEncodingsmodifiedAtnameregionsecurityGroupIdsshPortsubnetId
\ No newline at end of file diff --git a/docs/classes/AzureAccount.html b/docs/classes/AzureAccount.html index 10b7d12c7..d6dff75d8 100644 --- a/docs/classes/AzureAccount.html +++ b/docs/classes/AzureAccount.html @@ -1,5 +1,5 @@ AzureAccount | @bitmovin/api-sdk

Class AzureAccount

Export

AzureAccount

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,22 +9,22 @@ resourceGroupId? subscriptionId? tenantId? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional resourceGroupId

resourceGroupId?: string

The name of the resource group where you intend to run the Encoding VMs (required)

+

Optional resourceGroupId

resourceGroupId?: string

The name of the resource group where you intend to run the Encoding VMs (required)

Memberof

AzureAccount

-

Optional subscriptionId

subscriptionId?: string

Your Azure Subscription ID (The ID of your subscription where you intend to run the Encoding VMs) (required)

+

Optional subscriptionId

subscriptionId?: string

Your Azure Subscription ID (The ID of your subscription where you intend to run the Encoding VMs) (required)

Memberof

AzureAccount

-

Optional tenantId

tenantId?: string

The ID of your Active Directory where your subscription runs in (required)

+

Optional tenantId

tenantId?: string

The ID of your Active Directory where your subscription runs in (required)

Memberof

AzureAccount

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameresourceGroupIdsubscriptionIdtenantId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameresourceGroupIdsubscriptionIdtenantId
\ No newline at end of file diff --git a/docs/classes/AzureAccountRegionSettings.html b/docs/classes/AzureAccountRegionSettings.html index 29de13fef..367308aed 100644 --- a/docs/classes/AzureAccountRegionSettings.html +++ b/docs/classes/AzureAccountRegionSettings.html @@ -1,5 +1,5 @@ AzureAccountRegionSettings | @bitmovin/api-sdk

Class AzureAccountRegionSettings

Export

AzureAccountRegionSettings

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,21 +9,21 @@ networkName? region? subnetName? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional networkName

networkName?: string

Name of the virtual network (required)

+

Optional networkName

networkName?: string

Name of the virtual network (required)

Memberof

AzureAccountRegionSettings

-

Optional region

region?: AzureCloudRegion

Memberof

AzureAccountRegionSettings

-

Optional subnetName

subnetName?: string

Name of the subnet (required)

+

Optional region

region?: AzureCloudRegion

Memberof

AzureAccountRegionSettings

+

Optional subnetName

subnetName?: string

Name of the subnet (required)

Memberof

AzureAccountRegionSettings

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamenetworkNameregionsubnetName
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamenetworkNameregionsubnetName
\ No newline at end of file diff --git a/docs/classes/AzureInput.html b/docs/classes/AzureInput.html index 9a034a34d..b3d26fede 100644 --- a/docs/classes/AzureInput.html +++ b/docs/classes/AzureInput.html @@ -1,5 +1,5 @@ AzureInput | @bitmovin/api-sdk

Class AzureInput

Export

AzureInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accountKey? accountName? container? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accountKey

accountKey?: string

Azure Account Key (required)

+

Constructors

constructor

Properties

Optional accountKey

accountKey?: string

Azure Account Key (required)

Memberof

AzureInput

-

Optional accountName

accountName?: string

Azure Account Name (required)

+

Optional accountName

accountName?: string

Azure Account Name (required)

Memberof

AzureInput

-

Optional container

container?: string

Name of the bucket (required)

+

Optional container

container?: string

Name of the bucket (required)

Memberof

AzureInput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputType = InputType.AZURE

Discriminator property for Input

+

Readonly type

type: InputType = InputType.AZURE

Discriminator property for Input

Memberof

AzureInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccountKeyaccountNamecontainercreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccountKeyaccountNamecontainercreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AzureOutput.html b/docs/classes/AzureOutput.html index a4c5dc862..d6eba7114 100644 --- a/docs/classes/AzureOutput.html +++ b/docs/classes/AzureOutput.html @@ -1,5 +1,5 @@ AzureOutput | @bitmovin/api-sdk

Class AzureOutput

Export

AzureOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accountKey? accountName? acl? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accountKey

accountKey?: string

Azure Account Key (required)

+

Constructors

constructor

Properties

Optional accountKey

accountKey?: string

Azure Account Key (required)

Memberof

AzureOutput

-

Optional accountName

accountName?: string

Azure Account Name (required)

+

Optional accountName

accountName?: string

Azure Account Name (required)

Memberof

AzureOutput

-

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional container

container?: string

Name of the bucket (required)

+

Optional container

container?: string

Name of the bucket (required)

Memberof

AzureOutput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: OutputType = OutputType.AZURE

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.AZURE

Discriminator property for Output

Memberof

AzureOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccountKeyaccountNameaclcontainercreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccountKeyaccountNameaclcontainercreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AzureSpeechServicesCredentials.html b/docs/classes/AzureSpeechServicesCredentials.html index 854c4d717..58ce05e9a 100644 --- a/docs/classes/AzureSpeechServicesCredentials.html +++ b/docs/classes/AzureSpeechServicesCredentials.html @@ -1,6 +1,6 @@ AzureSpeechServicesCredentials | @bitmovin/api-sdk

Class AzureSpeechServicesCredentials

Export

AzureSpeechServicesCredentials

-

Constructors

constructor +

Constructors

constructor

Properties

subscriptionKey? -

Constructors

constructor

Properties

Optional subscriptionKey

subscriptionKey?: string

Azure Speech Services resource key (required)

+

Constructors

constructor

Properties

Optional subscriptionKey

subscriptionKey?: string

Azure Speech Services resource key (required)

Memberof

AzureSpeechServicesCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorsubscriptionKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorsubscriptionKey
\ No newline at end of file diff --git a/docs/classes/AzureSpeechToCaptionsFilter.html b/docs/classes/AzureSpeechToCaptionsFilter.html index 576cb7174..60fd5994b 100644 --- a/docs/classes/AzureSpeechToCaptionsFilter.html +++ b/docs/classes/AzureSpeechToCaptionsFilter.html @@ -1,5 +1,5 @@ AzureSpeechToCaptionsFilter | @bitmovin/api-sdk

Class AzureSpeechToCaptionsFilter

Export

AzureSpeechToCaptionsFilter

-

Hierarchy (view full)

  • Filter
    • AzureSpeechToCaptionsFilter

Constructors

constructor +

Hierarchy (view full)

  • Filter
    • AzureSpeechToCaptionsFilter

Constructors

constructor

Properties

azureSpeechToCaptionsSettings? createdAt? customData? @@ -10,19 +10,19 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional azureSpeechToCaptionsSettings

azureSpeechToCaptionsSettings?: AzureSpeechToCaptionsSettings

Memberof

AzureSpeechToCaptionsFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional azureSpeechToCaptionsSettings

azureSpeechToCaptionsSettings?: AzureSpeechToCaptionsSettings

Memberof

AzureSpeechToCaptionsFilter

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: FilterType = FilterType.AZURE_SPEECH_TO_CAPTIONS

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.AZURE_SPEECH_TO_CAPTIONS

Discriminator property for Filter

Memberof

AzureSpeechToCaptionsFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorazureSpeechToCaptionsSettingscreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorazureSpeechToCaptionsSettingscreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/AzureSpeechToCaptionsSettings.html b/docs/classes/AzureSpeechToCaptionsSettings.html index 33288243c..c1dac1422 100644 --- a/docs/classes/AzureSpeechToCaptionsSettings.html +++ b/docs/classes/AzureSpeechToCaptionsSettings.html @@ -1,5 +1,5 @@ AzureSpeechToCaptionsSettings | @bitmovin/api-sdk

Class AzureSpeechToCaptionsSettings

Export

AzureSpeechToCaptionsSettings

-

Constructors

constructor +

Constructors

constructor

Properties

apiEndpoint? azureSpeechServicesCredentials? captionDelay? @@ -9,22 +9,22 @@ language? profanityOption? region? -

Constructors

constructor

Properties

Optional apiEndpoint

apiEndpoint?: string

Azure Speech Services API endpoint. This information can be found in Azure's Speech resource data.

+

Constructors

constructor

Properties

Optional apiEndpoint

apiEndpoint?: string

Azure Speech Services API endpoint. This information can be found in Azure's Speech resource data.

Memberof

AzureSpeechToCaptionsSettings

-

Optional azureSpeechServicesCredentials

azureSpeechServicesCredentials?: AzureSpeechServicesCredentials

Credential settings to access Azure Speech Services

+

Optional azureSpeechServicesCredentials

azureSpeechServicesCredentials?: AzureSpeechServicesCredentials

Credential settings to access Azure Speech Services

Memberof

AzureSpeechToCaptionsSettings

-

Optional captionDelay

captionDelay?: number

How many MILLISECONDS to delay the display of each caption, to mimic a real-time experience. The minimum value is 0.

+

Optional captionDelay

captionDelay?: number

How many MILLISECONDS to delay the display of each caption, to mimic a real-time experience. The minimum value is 0.

Memberof

AzureSpeechToCaptionsSettings

-

Optional captionLines

captionLines?: number

The number of lines for a caption. The minimum value is 1.

+

Optional captionLines

captionLines?: number

The number of lines for a caption. The minimum value is 1.

Memberof

AzureSpeechToCaptionsSettings

-

Optional captionMaxLineLength

captionMaxLineLength?: number

The maximum number of characters per line for a caption. The minimum value is 20.

+

Optional captionMaxLineLength

captionMaxLineLength?: number

The maximum number of characters per line for a caption. The minimum value is 20.

Memberof

AzureSpeechToCaptionsSettings

-

Optional captionRemainTime

captionRemainTime?: number

How many MILLISECONDS a caption should remain on screen if it is not replaced by another. The minimum value is 0.

+

Optional captionRemainTime

captionRemainTime?: number

How many MILLISECONDS a caption should remain on screen if it is not replaced by another. The minimum value is 0.

Memberof

AzureSpeechToCaptionsSettings

-

Optional language

language?: string

Azure Speech to captions supported language (IETF BCP 47 language tag). The list of supported languages can be found at Azure's official documentation.

+

Optional language

language?: string

Azure Speech to captions supported language (IETF BCP 47 language tag). The list of supported languages can be found at Azure's official documentation.

Memberof

AzureSpeechToCaptionsSettings

-

Optional profanityOption

profanityOption?: AzureSpeechToCaptionsProfanity

The profanity filter options are: - Masked: Replaces letters in profane words with asterisk (*) characters. - Raw: Include the profane words verbatim. - Removed: Removes profane words.

+

Optional profanityOption

profanityOption?: AzureSpeechToCaptionsProfanity

The profanity filter options are: - Masked: Replaces letters in profane words with asterisk (*) characters. - Raw: Include the profane words verbatim. - Removed: Removes profane words.

Memberof

AzureSpeechToCaptionsSettings

-

Optional region

region?: string

Azure Speech Services Region Identifier. The list of speech service supported regions can be found at Azure's official documentation.

+

Optional region

region?: string

Azure Speech Services Region Identifier. The list of speech service supported regions can be found at Azure's official documentation.

Memberof

AzureSpeechToCaptionsSettings

-

Settings

Member Visibility

Theme

On This Page

constructorapiEndpointazureSpeechServicesCredentialscaptionDelaycaptionLinescaptionMaxLineLengthcaptionRemainTimelanguageprofanityOptionregion
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiEndpointazureSpeechServicesCredentialscaptionDelaycaptionLinescaptionMaxLineLengthcaptionRemainTimelanguageprofanityOptionregion
\ No newline at end of file diff --git a/docs/classes/BackupSrtInputs.html b/docs/classes/BackupSrtInputs.html index 83671584f..a0b2e1022 100644 --- a/docs/classes/BackupSrtInputs.html +++ b/docs/classes/BackupSrtInputs.html @@ -1,8 +1,8 @@ BackupSrtInputs | @bitmovin/api-sdk

Class BackupSrtInputs

Export

BackupSrtInputs

-

Constructors

constructor +

Constructors

constructor

Properties

delayThreshold? srtInputs? -

Constructors

constructor

Properties

Optional delayThreshold

delayThreshold?: number

When there is no input signal present for this number of seconds, the encoder will switch to the next input

+

Constructors

constructor

Properties

Optional delayThreshold

delayThreshold?: number

When there is no input signal present for this number of seconds, the encoder will switch to the next input

Memberof

BackupSrtInputs

-

Optional srtInputs

srtInputs?: SrtInput[]

Memberof

BackupSrtInputs

-

Settings

Member Visibility

Theme

On This Page

constructordelayThresholdsrtInputs
\ No newline at end of file +

Optional srtInputs

srtInputs?: SrtInput[]

Memberof

BackupSrtInputs

+

Settings

Member Visibility

Theme

On This Page

constructordelayThresholdsrtInputs
\ No newline at end of file diff --git a/docs/classes/BasicMediaInfo.html b/docs/classes/BasicMediaInfo.html index adabc0fcd..5cd12c57e 100644 --- a/docs/classes/BasicMediaInfo.html +++ b/docs/classes/BasicMediaInfo.html @@ -1,5 +1,5 @@ BasicMediaInfo | @bitmovin/api-sdk

Class BasicMediaInfo

Export

BasicMediaInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assocLanguage? autoselect? characteristics? @@ -8,20 +8,20 @@ isDefault? language? name? -

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

+

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

Memberof

BasicMediaInfo

-

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

+

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

Memberof

BasicMediaInfo

-

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

+

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

Memberof

BasicMediaInfo

-

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

+

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

Memberof

BasicMediaInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

+

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

Memberof

BasicMediaInfo

-

Optional language

language?: string

Primary language in the rendition.

+

Optional language

language?: string

Primary language in the rendition.

Memberof

BasicMediaInfo

-

Optional name

name?: string

Human readable description of the rendition. (required)

+

Optional name

name?: string

Human readable description of the rendition. (required)

Memberof

BasicMediaInfo

-

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsgroupIdidisDefaultlanguagename
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsgroupIdidisDefaultlanguagename
\ No newline at end of file diff --git a/docs/classes/Bif.html b/docs/classes/Bif.html index b35ceffc9..b10caa967 100644 --- a/docs/classes/Bif.html +++ b/docs/classes/Bif.html @@ -1,6 +1,6 @@ Bif | @bitmovin/api-sdk

Class Bif

Either height or width is required. It is also possible to set both properties.

Export

Bif

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

aspectMode? createdAt? customData? @@ -13,27 +13,27 @@ name? outputs? width? -

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: ThumbnailAspectMode

Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.

+

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: ThumbnailAspectMode

Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.

Memberof

Bif

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional distance

distance?: number

Distance in seconds between a screenshot (required)

+

Optional distance

distance?: number

Distance in seconds between a screenshot (required)

Memberof

Bif

-

Optional filename

filename?: string

Filename of the Bif image. (required)

+

Optional filename

filename?: string

Filename of the Bif image. (required)

Memberof

Bif

-

Optional height

height?: number

Height of one thumbnail

+

Optional height

height?: number

Height of one thumbnail

Memberof

Bif

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Bif

-

Optional width

width?: number

Width of one thumbnail. Roku recommends a width of 240 for SD and 320 for HD.

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Bif

+

Optional width

width?: number

Width of one thumbnail. Roku recommends a width of 240 for SD and 320 for HD.

Memberof

Bif

-

Settings

Member Visibility

Theme

On This Page

constructoraspectModecreatedAtcustomDatadescriptiondistancefilenameheightidmodifiedAtnameoutputswidth
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraspectModecreatedAtcustomDatadescriptiondistancefilenameheightidmodifiedAtnameoutputswidth
\ No newline at end of file diff --git a/docs/classes/BillableEncodingFeatureMinutes.html b/docs/classes/BillableEncodingFeatureMinutes.html index 79de9e9aa..c5f2297af 100644 --- a/docs/classes/BillableEncodingFeatureMinutes.html +++ b/docs/classes/BillableEncodingFeatureMinutes.html @@ -1,15 +1,15 @@ BillableEncodingFeatureMinutes | @bitmovin/api-sdk

Class BillableEncodingFeatureMinutes

Export

BillableEncodingFeatureMinutes

-

Constructors

constructor +

Constructors

constructor

Properties

billableMinutes? encodedMinutes? featureMultiplier? featureType? -

Constructors

constructor

Properties

Optional billableMinutes

billableMinutes?: number

The billable minutes related to this feature.

+

Constructors

constructor

Properties

Optional billableMinutes

billableMinutes?: number

The billable minutes related to this feature.

Memberof

BillableEncodingFeatureMinutes

-

Optional encodedMinutes

encodedMinutes?: number

Encoded minutes related to this feature.

+

Optional encodedMinutes

encodedMinutes?: number

Encoded minutes related to this feature.

Memberof

BillableEncodingFeatureMinutes

-

Optional featureMultiplier

featureMultiplier?: number

The multiplier used for this feature.

+

Optional featureMultiplier

featureMultiplier?: number

The multiplier used for this feature.

Memberof

BillableEncodingFeatureMinutes

-

Optional featureType

featureType?: string

The name of the feature.

+

Optional featureType

featureType?: string

The name of the feature.

Memberof

BillableEncodingFeatureMinutes

-

Settings

Member Visibility

Theme

On This Page

constructorbillableMinutesencodedMinutesfeatureMultiplierfeatureType
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableMinutesencodedMinutesfeatureMultiplierfeatureType
\ No newline at end of file diff --git a/docs/classes/BillableEncodingMinutes.html b/docs/classes/BillableEncodingMinutes.html index 43065925e..c132d4789 100644 --- a/docs/classes/BillableEncodingMinutes.html +++ b/docs/classes/BillableEncodingMinutes.html @@ -1,5 +1,5 @@ BillableEncodingMinutes | @bitmovin/api-sdk

Class BillableEncodingMinutes

Export

BillableEncodingMinutes

-

Constructors

constructor +

Constructors

constructor

Properties

billableMinutes? codec? encodingMode? @@ -10,17 +10,17 @@ pixelFormatBitDepth? preset? psnrMode? -

Constructors

constructor

Properties

Optional billableMinutes

billableMinutes?: BillableEncodingMinutesDetails

Memberof

BillableEncodingMinutes

-

Optional codec

codec?: CodecConfigType

Memberof

BillableEncodingMinutes

-

Optional encodingMode

encodingMode?: EncodingMode

Memberof

BillableEncodingMinutes

-

Optional enhancedDeinterlace

enhancedDeinterlace?: boolean

Indicates if an enhanced interlace filter was used.

+

Constructors

constructor

Properties

Optional billableMinutes

billableMinutes?: BillableEncodingMinutesDetails

Memberof

BillableEncodingMinutes

+

Optional codec

codec?: CodecConfigType

Memberof

BillableEncodingMinutes

+

Optional encodingMode

encodingMode?: EncodingMode

Memberof

BillableEncodingMinutes

+

Optional enhancedDeinterlace

enhancedDeinterlace?: boolean

Indicates if an enhanced interlace filter was used.

Memberof

BillableEncodingMinutes

-

Optional live

live?: boolean

Indicates if the stream was part of a live encoding.

+

Optional live

live?: boolean

Indicates if the stream was part of a live encoding.

Memberof

BillableEncodingMinutes

-

Optional nexGuardABWatermarkingType

nexGuardABWatermarkingType?: NexGuardABWatermarkingFeature

Memberof

BillableEncodingMinutes

-

Optional perTitleResultStream

perTitleResultStream?: StatisticsPerTitleStream

Memberof

BillableEncodingMinutes

-

Optional pixelFormatBitDepth

pixelFormatBitDepth?: PixelFormatBitDepth

Memberof

BillableEncodingMinutes

-

Optional preset

preset?: string

Name of the preset configuration used for the codec configuration or "CUSTOM" if any preset values were overridden

+

Optional nexGuardABWatermarkingType

nexGuardABWatermarkingType?: NexGuardABWatermarkingFeature

Memberof

BillableEncodingMinutes

+

Optional perTitleResultStream

perTitleResultStream?: StatisticsPerTitleStream

Memberof

BillableEncodingMinutes

+

Optional pixelFormatBitDepth

pixelFormatBitDepth?: PixelFormatBitDepth

Memberof

BillableEncodingMinutes

+

Optional preset

preset?: string

Name of the preset configuration used for the codec configuration or "CUSTOM" if any preset values were overridden

Memberof

BillableEncodingMinutes

-

Optional psnrMode

psnrMode?: PsnrPerStreamMode

Memberof

BillableEncodingMinutes

-

Settings

Member Visibility

Theme

On This Page

constructorbillableMinutescodecencodingModeenhancedDeinterlacelivenexGuardABWatermarkingTypeperTitleResultStreampixelFormatBitDepthpresetpsnrMode
\ No newline at end of file +

Optional psnrMode

psnrMode?: PsnrPerStreamMode

Memberof

BillableEncodingMinutes

+

Settings

Member Visibility

Theme

On This Page

constructorbillableMinutescodecencodingModeenhancedDeinterlacelivenexGuardABWatermarkingTypeperTitleResultStreampixelFormatBitDepthpresetpsnrMode
\ No newline at end of file diff --git a/docs/classes/BillableEncodingMinutesDetails.html b/docs/classes/BillableEncodingMinutesDetails.html index f909f1c06..d407df1a9 100644 --- a/docs/classes/BillableEncodingMinutesDetails.html +++ b/docs/classes/BillableEncodingMinutesDetails.html @@ -1,18 +1,18 @@ BillableEncodingMinutesDetails | @bitmovin/api-sdk

Class BillableEncodingMinutesDetails

Export

BillableEncodingMinutesDetails

-

Constructors

constructor +

Constructors

constructor

Properties

AUDIO? HD? SD? UHD? UNKNOWN? -

Constructors

constructor

Properties

Optional AUDIO

AUDIO?: number

Billable minutes for audio. Available if stream is an audio stream.

+

Constructors

constructor

Properties

Optional AUDIO

AUDIO?: number

Billable minutes for audio. Available if stream is an audio stream.

Memberof

BillableEncodingMinutesDetails

-

Optional HD

HD?: number

Billable minutes for HD resolutions.

+

Optional HD

HD?: number

Billable minutes for HD resolutions.

Memberof

BillableEncodingMinutesDetails

-

Optional SD

SD?: number

Billable minutes for SD resolutions.

+

Optional SD

SD?: number

Billable minutes for SD resolutions.

Memberof

BillableEncodingMinutesDetails

-

Optional UHD

UHD?: number

Billable minutes for UHD resolutions.

+

Optional UHD

UHD?: number

Billable minutes for UHD resolutions.

Memberof

BillableEncodingMinutesDetails

-

Optional UNKNOWN

UNKNOWN?: number

Only set if resolution information is not present.

+

Optional UNKNOWN

UNKNOWN?: number

Only set if resolution information is not present.

Memberof

BillableEncodingMinutesDetails

-

Settings

Member Visibility

Theme

On This Page

constructorAUDIOHDSDUHDUNKNOWN
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorAUDIOHDSDUHDUNKNOWN
\ No newline at end of file diff --git a/docs/classes/BitmovinError.html b/docs/classes/BitmovinError.html index 91497d459..a577f36ad 100644 --- a/docs/classes/BitmovinError.html +++ b/docs/classes/BitmovinError.html @@ -1,4 +1,4 @@ -BitmovinError | @bitmovin/api-sdk

Class BitmovinError

Hierarchy

  • Error
    • BitmovinError

Constructors

constructor +BitmovinError | @bitmovin/api-sdk

Class BitmovinError

Hierarchy

  • Error
    • BitmovinError

Constructors

constructor

Properties

details? developerMessage? errorCode? @@ -12,7 +12,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional details

details?: Message[]

Optional developerMessage

developerMessage?: string

Optional errorCode

errorCode?: number

httpStatusCode

httpStatusCode: number

Optional links

links?: Link[]

message

message: string

name

name: string

Optional requestId

requestId?: string

shortMessage

shortMessage: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional details

details?: Message[]

Optional developerMessage

developerMessage?: string

Optional errorCode

errorCode?: number

httpStatusCode

httpStatusCode: number

Optional links

links?: Link[]

message

message: string

name

name: string

Optional requestId

requestId?: string

shortMessage

shortMessage: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructordetailsdeveloperMessageerrorCodehttpStatusCodelinksmessagenamerequestIdshortMessagestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/docs/classes/BitmovinResource.html b/docs/classes/BitmovinResource.html index e94d7ee7b..bcd8128f0 100644 --- a/docs/classes/BitmovinResource.html +++ b/docs/classes/BitmovinResource.html @@ -1,21 +1,21 @@ BitmovinResource | @bitmovin/api-sdk

Class BitmovinResource

Export

BitmovinResource

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? id? modifiedAt? name? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname
\ No newline at end of file diff --git a/docs/classes/BitmovinResponse.html b/docs/classes/BitmovinResponse.html index 12a191dac..1db5b4003 100644 --- a/docs/classes/BitmovinResponse.html +++ b/docs/classes/BitmovinResponse.html @@ -1,6 +1,6 @@ BitmovinResponse | @bitmovin/api-sdk

Class BitmovinResponse

Export

BitmovinResponse

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Settings

Member Visibility

Theme

On This Page

constructorid
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorid
\ No newline at end of file diff --git a/docs/classes/BitmovinResponseList.html b/docs/classes/BitmovinResponseList.html index 2ee61c947..7d0a7fb8e 100644 --- a/docs/classes/BitmovinResponseList.html +++ b/docs/classes/BitmovinResponseList.html @@ -1,5 +1,5 @@ BitmovinResponseList | @bitmovin/api-sdk

Class BitmovinResponseList

Export

BitmovinResponseList

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

[unscopables] length [species] @@ -39,7 +39,7 @@ from isArray of -

Constructors

constructor

Properties

Readonly [unscopables]

[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    at?: any;
    concat?: any;
    copyWithin?: any;
    entries?: any;
    every?: any;
    fill?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    flat?: any;
    flatMap?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    pop?: any;
    push?: any;
    reduce?: any;
    reduceRight?: any;
    reverse?: any;
    shift?: any;
    slice?: any;
    some?: any;
    sort?: any;
    splice?: any;
    toLocaleString?: any;
    toString?: any;
    unshift?: any;
    values?: any;
}

Is an object whose properties have the value 'true' +

Constructors

constructor

Properties

Readonly [unscopables]

[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    at?: any;
    concat?: any;
    copyWithin?: any;
    entries?: any;
    every?: any;
    fill?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    flat?: any;
    flatMap?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    pop?: any;
    push?: any;
    reduce?: any;
    reduceRight?: any;
    reverse?: any;
    shift?: any;
    slice?: any;
    some?: any;
    sort?: any;
    splice?: any;
    toLocaleString?: any;
    toString?: any;
    unshift?: any;
    values?: any;
}

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Type declaration

  • Optional Readonly [unscopables]?: boolean

    Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    @@ -49,7 +49,7 @@

    Returns IterableIterator<BitmovinResponse>

at

  • at(index): undefined | BitmovinResponse

  • Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | BitmovinResponse

concat

  • concat(...items): BitmovinResponse[]

  • Combines two or more arrays. +

    Parameters

    • index: number

    Returns undefined | BitmovinResponse

concat

Settings

Member Visibility

Theme

On This Page

constructoralignPeslanguagepacketIdentifiersetRaiOnAustartWithDiscontinuityIndicatorstreamIduseATSCBufferModel
\ No newline at end of file diff --git a/docs/classes/BroadcastTsInputStreamConfiguration.html b/docs/classes/BroadcastTsInputStreamConfiguration.html index 703525bac..cdfcae6e1 100644 --- a/docs/classes/BroadcastTsInputStreamConfiguration.html +++ b/docs/classes/BroadcastTsInputStreamConfiguration.html @@ -1,17 +1,17 @@ BroadcastTsInputStreamConfiguration | @bitmovin/api-sdk

Class BroadcastTsInputStreamConfiguration

Export

BroadcastTsInputStreamConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

alignPes? packetIdentifier? setRaiOnAu? startWithDiscontinuityIndicator? streamId? -

Constructors

constructor

Properties

Optional alignPes

alignPes?: boolean

Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet.

+

Constructors

constructor

Properties

Optional alignPes

alignPes?: boolean

Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet.

Memberof

BroadcastTsInputStreamConfiguration

-

Optional packetIdentifier

packetIdentifier?: number

An integer value. Packet Identifier (PID) for this stream.

+

Optional packetIdentifier

packetIdentifier?: number

An integer value. Packet Identifier (PID) for this stream.

Memberof

BroadcastTsInputStreamConfiguration

-

Optional setRaiOnAu

setRaiOnAu?: RaiUnit

Memberof

BroadcastTsInputStreamConfiguration

-

Optional startWithDiscontinuityIndicator

startWithDiscontinuityIndicator?: boolean

Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID.

+

Optional setRaiOnAu

setRaiOnAu?: RaiUnit

Memberof

BroadcastTsInputStreamConfiguration

+

Optional startWithDiscontinuityIndicator

startWithDiscontinuityIndicator?: boolean

Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID.

Memberof

BroadcastTsInputStreamConfiguration

-

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.

+

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.

Memberof

BroadcastTsInputStreamConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructoralignPespacketIdentifiersetRaiOnAustartWithDiscontinuityIndicatorstreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoralignPespacketIdentifiersetRaiOnAustartWithDiscontinuityIndicatorstreamId
\ No newline at end of file diff --git a/docs/classes/BroadcastTsMuxing.html b/docs/classes/BroadcastTsMuxing.html index 29da5a771..9b11bb6e7 100644 --- a/docs/classes/BroadcastTsMuxing.html +++ b/docs/classes/BroadcastTsMuxing.html @@ -1,5 +1,5 @@ BroadcastTsMuxing | @bitmovin/api-sdk

Class BroadcastTsMuxing

Export

BroadcastTsMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? configuration? createdAt? @@ -19,35 +19,35 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional configuration

configuration?: BroadcastTsMuxingConfiguration

Memberof

BroadcastTsMuxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional configuration

configuration?: BroadcastTsMuxingConfiguration

Memberof

BroadcastTsMuxing

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional filename

filename?: string

Name of the output file

+

Optional filename

filename?: string

Name of the output file

Memberof

BroadcastTsMuxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Length of the segments in seconds.

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Length of the segments in seconds.

Memberof

BroadcastTsMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.BROADCAST_TS

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.BROADCAST_TS

Discriminator property for Muxing

Memberof

BroadcastTsMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitrateconfigurationcreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitrateconfigurationcreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/BroadcastTsMuxingConfiguration.html b/docs/classes/BroadcastTsMuxingConfiguration.html index 9981d67f0..3008bd26d 100644 --- a/docs/classes/BroadcastTsMuxingConfiguration.html +++ b/docs/classes/BroadcastTsMuxingConfiguration.html @@ -1,15 +1,15 @@ BroadcastTsMuxingConfiguration | @bitmovin/api-sdk

Class BroadcastTsMuxingConfiguration

Export

BroadcastTsMuxingConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

audioStreams? program? subtitleStreams? transport? videoStreams? -

Constructors

constructor

Properties

Optional audioStreams

audioStreams?: BroadcastTsAudioInputStreamConfiguration[]

Memberof

BroadcastTsMuxingConfiguration

-

Optional program

program?: BroadcastTsProgramConfiguration

Program configuration details for the Broadcast TS muxing.

+

Constructors

constructor

Properties

Optional audioStreams

audioStreams?: BroadcastTsAudioInputStreamConfiguration[]

Memberof

BroadcastTsMuxingConfiguration

+

Optional program

program?: BroadcastTsProgramConfiguration

Program configuration details for the Broadcast TS muxing.

Memberof

BroadcastTsMuxingConfiguration

-

Optional subtitleStreams

subtitleStreams?: BroadcastTsSubtitleInputStreamConfiguration[]

Memberof

BroadcastTsMuxingConfiguration

-

Optional transport

transport?: BroadcastTsTransportConfiguration

Transport configuration details for the Broadcast TS muxing.

+

Optional subtitleStreams

subtitleStreams?: BroadcastTsSubtitleInputStreamConfiguration[]

Memberof

BroadcastTsMuxingConfiguration

+

Optional transport

transport?: BroadcastTsTransportConfiguration

Transport configuration details for the Broadcast TS muxing.

Memberof

BroadcastTsMuxingConfiguration

-

Optional videoStreams

videoStreams?: BroadcastTsVideoInputStreamConfiguration[]

Memberof

BroadcastTsMuxingConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructoraudioStreamsprogramsubtitleStreamstransportvideoStreams
\ No newline at end of file +

Optional videoStreams

videoStreams?: BroadcastTsVideoInputStreamConfiguration[]

Memberof

BroadcastTsMuxingConfiguration

+

Settings

Member Visibility

Theme

On This Page

constructoraudioStreamsprogramsubtitleStreamstransportvideoStreams
\ No newline at end of file diff --git a/docs/classes/BroadcastTsMuxingInformation.html b/docs/classes/BroadcastTsMuxingInformation.html index 596f29079..568f0e8dd 100644 --- a/docs/classes/BroadcastTsMuxingInformation.html +++ b/docs/classes/BroadcastTsMuxingInformation.html @@ -1,5 +1,5 @@ BroadcastTsMuxingInformation | @bitmovin/api-sdk

Class BroadcastTsMuxingInformation

Export

BroadcastTsMuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

ProgressiveMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

ProgressiveMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

ProgressiveMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

ProgressiveMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

ProgressiveMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

ProgressiveMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

ProgressiveMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/BroadcastTsProgramConfiguration.html b/docs/classes/BroadcastTsProgramConfiguration.html index 036b6ae02..f5da89cbd 100644 --- a/docs/classes/BroadcastTsProgramConfiguration.html +++ b/docs/classes/BroadcastTsProgramConfiguration.html @@ -1,15 +1,15 @@ BroadcastTsProgramConfiguration | @bitmovin/api-sdk

Class BroadcastTsProgramConfiguration

Export

BroadcastTsProgramConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

insertProgramClockRefOnPes? pidForPMT? programClockRefInterval? programNumber? -

Constructors

constructor

Properties

Optional insertProgramClockRefOnPes

insertProgramClockRefOnPes?: boolean

Insert Program Clock References (PCRs) on all packetized elemementary stream packets. When false, indicates that PCRs should be inserted on every PES header. This parameter is effective only when the PCR packet identifier is the same as a video or audio elementary stream.

+

Constructors

constructor

Properties

Optional insertProgramClockRefOnPes

insertProgramClockRefOnPes?: boolean

Insert Program Clock References (PCRs) on all packetized elemementary stream packets. When false, indicates that PCRs should be inserted on every PES header. This parameter is effective only when the PCR packet identifier is the same as a video or audio elementary stream.

Memberof

BroadcastTsProgramConfiguration

-

Optional pidForPMT

pidForPMT?: number

An integer value. Packet identifier (PID) to use for Program Map Table (PMT). Recommended value is 2 x programNumber.

+

Optional pidForPMT

pidForPMT?: number

An integer value. Packet identifier (PID) to use for Program Map Table (PMT). Recommended value is 2 x programNumber.

Memberof

BroadcastTsProgramConfiguration

-

Optional programClockRefInterval

programClockRefInterval?: number

Interval between Program Clock References (PCRs) in milliseconds. Defines the period between PCR fields inserted in the stream. The default value is 90ms.

+

Optional programClockRefInterval

programClockRefInterval?: number

Interval between Program Clock References (PCRs) in milliseconds. Defines the period between PCR fields inserted in the stream. The default value is 90ms.

Memberof

BroadcastTsProgramConfiguration

-

Optional programNumber

programNumber?: number

An integer value. Value for program_number field in Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.

+

Optional programNumber

programNumber?: number

An integer value. Value for program_number field in Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.

Memberof

BroadcastTsProgramConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorinsertProgramClockRefOnPespidForPMTprogramClockRefIntervalprogramNumber
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorinsertProgramClockRefOnPespidForPMTprogramClockRefIntervalprogramNumber
\ No newline at end of file diff --git a/docs/classes/BroadcastTsSubtitleInputStreamConfiguration.html b/docs/classes/BroadcastTsSubtitleInputStreamConfiguration.html index e91498ea9..19d86f964 100644 --- a/docs/classes/BroadcastTsSubtitleInputStreamConfiguration.html +++ b/docs/classes/BroadcastTsSubtitleInputStreamConfiguration.html @@ -1,12 +1,12 @@ BroadcastTsSubtitleInputStreamConfiguration | @bitmovin/api-sdk

Class BroadcastTsSubtitleInputStreamConfiguration

Export

BroadcastTsSubtitleInputStreamConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

packetIdentifier? rate? streamId? -

Constructors

constructor

Properties

Optional packetIdentifier

packetIdentifier?: number

An integer value. Packet Identifier (PID) for this stream.

+

Constructors

constructor

Properties

Optional packetIdentifier

packetIdentifier?: number

An integer value. Packet Identifier (PID) for this stream.

Memberof

BroadcastTsSubtitleInputStreamConfiguration

-

Optional rate

rate?: number

The rate parameter determines the maximum rate in bits per second that should be used for the subtitle stream. The valid range is 100 to 60 000 000 bps or 0. If the value is set to 0, we will examine the first 100 packets of subtitle packet data and use the highest rate that was computed. If the value is set too low, not enough to accommodate the subtitle bit-rate, then some PES packets corresponding to DVB subtitle stream will be dropped. This parameter is optional and the default value is 0.

+

Optional rate

rate?: number

The rate parameter determines the maximum rate in bits per second that should be used for the subtitle stream. The valid range is 100 to 60 000 000 bps or 0. If the value is set to 0, we will examine the first 100 packets of subtitle packet data and use the highest rate that was computed. If the value is set too low, not enough to accommodate the subtitle bit-rate, then some PES packets corresponding to DVB subtitle stream will be dropped. This parameter is optional and the default value is 0.

Memberof

BroadcastTsSubtitleInputStreamConfiguration

-

Optional streamId

streamId?: string

The UUID of the subtitle stream to which this configuration belongs to. This has to be an ID of an subtitle stream that has been added to the current muxing.

+

Optional streamId

streamId?: string

The UUID of the subtitle stream to which this configuration belongs to. This has to be an ID of an subtitle stream that has been added to the current muxing.

Memberof

BroadcastTsSubtitleInputStreamConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorpacketIdentifierratestreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpacketIdentifierratestreamId
\ No newline at end of file diff --git a/docs/classes/BroadcastTsTransportConfiguration.html b/docs/classes/BroadcastTsTransportConfiguration.html index 8ebc048f6..f1d17faa5 100644 --- a/docs/classes/BroadcastTsTransportConfiguration.html +++ b/docs/classes/BroadcastTsTransportConfiguration.html @@ -1,5 +1,5 @@ BroadcastTsTransportConfiguration | @bitmovin/api-sdk

Class BroadcastTsTransportConfiguration

Export

BroadcastTsTransportConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

initialPresentationTimeStamp? initialProgramClockReference? muxrate? @@ -8,20 +8,20 @@ preventEmptyAdaptionFieldsInVideo? stopOnError? variableMuxRate? -

Constructors

constructor

Properties

Optional initialPresentationTimeStamp

initialPresentationTimeStamp?: number

Presentation time stamp value for the first video frame. The timestamp is specified in the timescale of 90000

+

Constructors

constructor

Properties

Optional initialPresentationTimeStamp

initialPresentationTimeStamp?: number

Presentation time stamp value for the first video frame. The timestamp is specified in the timescale of 90000

Memberof

BroadcastTsTransportConfiguration

-

Optional initialProgramClockReference

initialProgramClockReference?: number

Program Clock Reference value at the beginning of the first packet for the transport stream. The PCR is specified in the timescale of 90000

+

Optional initialProgramClockReference

initialProgramClockReference?: number

Program Clock Reference value at the beginning of the first packet for the transport stream. The PCR is specified in the timescale of 90000

Memberof

BroadcastTsTransportConfiguration

-

Optional muxrate

muxrate?: number

Output rate in bps. The value zero implies to use minimal rate. The minimal rate leaves approximately 15kbps of null packets in the stream.

+

Optional muxrate

muxrate?: number

Output rate in bps. The value zero implies to use minimal rate. The minimal rate leaves approximately 15kbps of null packets in the stream.

Memberof

BroadcastTsTransportConfiguration

-

Optional patRepetitionRatePerSec

patRepetitionRatePerSec?: number

Program Association Table (PAT) repetition rate per second. Number of PATs per second.

+

Optional patRepetitionRatePerSec

patRepetitionRatePerSec?: number

Program Association Table (PAT) repetition rate per second. Number of PATs per second.

Memberof

BroadcastTsTransportConfiguration

-

Optional pmtRepetitionRatePerSec

pmtRepetitionRatePerSec?: number

Program Map Table (PMT) repetition rate per second. Number of PMTs for each program per second.

+

Optional pmtRepetitionRatePerSec

pmtRepetitionRatePerSec?: number

Program Map Table (PMT) repetition rate per second. Number of PMTs for each program per second.

Memberof

BroadcastTsTransportConfiguration

-

Optional preventEmptyAdaptionFieldsInVideo

preventEmptyAdaptionFieldsInVideo?: boolean

If true, prevents adaptation fields with length field equal to zero in video, i.e., zero-length AF. Please note that this condition can only occur when pesAlign for the input stream is set to true.

+

Optional preventEmptyAdaptionFieldsInVideo

preventEmptyAdaptionFieldsInVideo?: boolean

If true, prevents adaptation fields with length field equal to zero in video, i.e., zero-length AF. Please note that this condition can only occur when pesAlign for the input stream is set to true.

Memberof

BroadcastTsTransportConfiguration

-

Optional stopOnError

stopOnError?: boolean

Stop mux on errors. If true, implies halt multiplexing when any error is encountered. If false, errors are ignored and multiplexing continues. Note that the recovery from an error will usually result in an illegal transport stream and artifacts on a decoder.

+

Optional stopOnError

stopOnError?: boolean

Stop mux on errors. If true, implies halt multiplexing when any error is encountered. If false, errors are ignored and multiplexing continues. Note that the recovery from an error will usually result in an illegal transport stream and artifacts on a decoder.

Memberof

BroadcastTsTransportConfiguration

-

Optional variableMuxRate

variableMuxRate?: boolean

When false, the output stream is created at a constant bit rate. When true, the output rate is allowed to vary from a maximum rate set by the muxrate parameter down to the minimum required to carry the stream.

+

Optional variableMuxRate

variableMuxRate?: boolean

When false, the output stream is created at a constant bit rate. When true, the output rate is allowed to vary from a maximum rate set by the muxrate parameter down to the minimum required to carry the stream.

Memberof

BroadcastTsTransportConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorinitialPresentationTimeStampinitialProgramClockReferencemuxratepatRepetitionRatePerSecpmtRepetitionRatePerSecpreventEmptyAdaptionFieldsInVideostopOnErrorvariableMuxRate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorinitialPresentationTimeStampinitialProgramClockReferencemuxratepatRepetitionRatePerSecpmtRepetitionRatePerSecpreventEmptyAdaptionFieldsInVideostopOnErrorvariableMuxRate
\ No newline at end of file diff --git a/docs/classes/BroadcastTsVideoInputStreamConfiguration.html b/docs/classes/BroadcastTsVideoInputStreamConfiguration.html index 3c86fcf96..0d909e82e 100644 --- a/docs/classes/BroadcastTsVideoInputStreamConfiguration.html +++ b/docs/classes/BroadcastTsVideoInputStreamConfiguration.html @@ -1,5 +1,5 @@ BroadcastTsVideoInputStreamConfiguration | @bitmovin/api-sdk

Class BroadcastTsVideoInputStreamConfiguration

Export

BroadcastTsVideoInputStreamConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

alignPes? insertAccessUnitDelimiterInAvc? maxDecodeDelay? @@ -7,17 +7,17 @@ setRaiOnAu? startWithDiscontinuityIndicator? streamId? -

Constructors

constructor

Properties

Optional alignPes

alignPes?: boolean

Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet.

+

Constructors

constructor

Properties

Optional alignPes

alignPes?: boolean

Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet.

Memberof

BroadcastTsInputStreamConfiguration

-

Optional insertAccessUnitDelimiterInAvc

insertAccessUnitDelimiterInAvc?: boolean

If true, add access unit delimiters (AUD) to AVC stream if AUD is missing from input elementary stream.

+

Optional insertAccessUnitDelimiterInAvc

insertAccessUnitDelimiterInAvc?: boolean

If true, add access unit delimiters (AUD) to AVC stream if AUD is missing from input elementary stream.

Memberof

BroadcastTsVideoInputStreamConfiguration

-

Optional maxDecodeDelay

maxDecodeDelay?: number

Maximum Decoder Delay in 90 KHz cycles. When non-zero, the difference between the PCR and the DTS for each picture as it is inserted into the output transport stream is limited to this number of 90 KHz cycles. Values below 1000 are treated as 0 and ignored. Valid Range [0, 1000-900000]

+

Optional maxDecodeDelay

maxDecodeDelay?: number

Maximum Decoder Delay in 90 KHz cycles. When non-zero, the difference between the PCR and the DTS for each picture as it is inserted into the output transport stream is limited to this number of 90 KHz cycles. Values below 1000 are treated as 0 and ignored. Valid Range [0, 1000-900000]

Memberof

BroadcastTsVideoInputStreamConfiguration

-

Optional packetIdentifier

packetIdentifier?: number

An integer value. Packet Identifier (PID) for this stream.

+

Optional packetIdentifier

packetIdentifier?: number

An integer value. Packet Identifier (PID) for this stream.

Memberof

BroadcastTsInputStreamConfiguration

-

Optional setRaiOnAu

setRaiOnAu?: RaiUnit

Memberof

BroadcastTsInputStreamConfiguration

-

Optional startWithDiscontinuityIndicator

startWithDiscontinuityIndicator?: boolean

Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID.

+

Optional setRaiOnAu

setRaiOnAu?: RaiUnit

Memberof

BroadcastTsInputStreamConfiguration

+

Optional startWithDiscontinuityIndicator

startWithDiscontinuityIndicator?: boolean

Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID.

Memberof

BroadcastTsInputStreamConfiguration

-

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.

+

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.

Memberof

BroadcastTsInputStreamConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructoralignPesinsertAccessUnitDelimiterInAvcmaxDecodeDelaypacketIdentifiersetRaiOnAustartWithDiscontinuityIndicatorstreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoralignPesinsertAccessUnitDelimiterInAvcmaxDecodeDelaypacketIdentifiersetRaiOnAustartWithDiscontinuityIndicatorstreamId
\ No newline at end of file diff --git a/docs/classes/BurnInSubtitleDvbSub.html b/docs/classes/BurnInSubtitleDvbSub.html index 458c1ef08..160eb047d 100644 --- a/docs/classes/BurnInSubtitleDvbSub.html +++ b/docs/classes/BurnInSubtitleDvbSub.html @@ -1,5 +1,5 @@ BurnInSubtitleDvbSub | @bitmovin/api-sdk

Class BurnInSubtitleDvbSub

Export

BurnInSubtitleDvbSub

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -7,18 +7,18 @@ inputStreamId? modifiedAt? name? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputStreamId

inputStreamId?: string

Id of an IngestInputStream which specifies the stream of the DVB-SUB subtitles (required)

+

Optional inputStreamId

inputStreamId?: string

Id of an IngestInputStream which specifies the stream of the DVB-SUB subtitles (required)

Memberof

BurnInSubtitleDvbSub

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputStreamIdmodifiedAtname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputStreamIdmodifiedAtname
\ No newline at end of file diff --git a/docs/classes/BurnInSubtitleSrt.html b/docs/classes/BurnInSubtitleSrt.html index db41f30b1..5458613cc 100644 --- a/docs/classes/BurnInSubtitleSrt.html +++ b/docs/classes/BurnInSubtitleSrt.html @@ -1,5 +1,5 @@ BurnInSubtitleSrt | @bitmovin/api-sdk

Class BurnInSubtitleSrt

Export

BurnInSubtitleSrt

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

characterEncoding? createdAt? customData? @@ -8,20 +8,20 @@ input? modifiedAt? name? -

Constructors

constructor

Properties

Optional characterEncoding

characterEncoding?: CaptionCharacterEncoding

Character encoding of the SRT file (required)

+

Constructors

constructor

Properties

Optional characterEncoding

characterEncoding?: CaptionCharacterEncoding

Character encoding of the SRT file (required)

Memberof

BurnInSubtitleSrt

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional input

input?: InputPath

The input location to get the SRT file from (required)

+

Optional input

input?: InputPath

The input location to get the SRT file from (required)

Memberof

BurnInSubtitleSrt

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Settings

Member Visibility

Theme

On This Page

constructorcharacterEncodingcreatedAtcustomDatadescriptionidinputmodifiedAtname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcharacterEncodingcreatedAtcustomDatadescriptionidinputmodifiedAtname
\ No newline at end of file diff --git a/docs/classes/CdnOutput.html b/docs/classes/CdnOutput.html index 90e9afafc..b3da5aa02 100644 --- a/docs/classes/CdnOutput.html +++ b/docs/classes/CdnOutput.html @@ -1,5 +1,5 @@ CdnOutput | @bitmovin/api-sdk

Class CdnOutput

Export

CdnOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -11,22 +11,22 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional domainName

domainName?: string

Domain name for public access to CDN content

+

Optional domainName

domainName?: string

Domain name for public access to CDN content

Memberof

CdnOutput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: OutputType = OutputType.CDN

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.CDN

Discriminator property for Output

Memberof

CdnOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptiondomainNameidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptiondomainNameidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/CdnUsage.html b/docs/classes/CdnUsage.html index e50625771..0be973084 100644 --- a/docs/classes/CdnUsage.html +++ b/docs/classes/CdnUsage.html @@ -1,15 +1,15 @@ CdnUsage | @bitmovin/api-sdk

Class CdnUsage

Export

CdnUsage

-

Constructors

constructor +

Constructors

constructor

Properties

from? storageUsage? to? transferUsage? -

Constructors

constructor

Properties

Optional from

from?: Date

UTC timestamp which marks the beginning of the time period for which the usage statistics are retrieved.

+

Constructors

constructor

Properties

Optional from

from?: Date

UTC timestamp which marks the beginning of the time period for which the usage statistics are retrieved.

Memberof

CdnUsage

-

Optional storageUsage

storageUsage?: number

Storage usage in GB per month.

+

Optional storageUsage

storageUsage?: number

Storage usage in GB per month.

Memberof

CdnUsage

-

Optional to

to?: Date

UTC timestamp which marks the end of the time period for which the usage statistics are retrieved. The end date is exclusive. For example, if end is 2019-03-29T13:05:00Z, the cost and usage data are retrieved from the start date up to, but not including, 2019-03-29T13:05:00Z.

+

Optional to

to?: Date

UTC timestamp which marks the end of the time period for which the usage statistics are retrieved. The end date is exclusive. For example, if end is 2019-03-29T13:05:00Z, the cost and usage data are retrieved from the start date up to, but not including, 2019-03-29T13:05:00Z.

Memberof

CdnUsage

-

Optional transferUsage

transferUsage?: number

Transfer usage in GB.

+

Optional transferUsage

transferUsage?: number

Transfer usage in GB.

Memberof

CdnUsage

-

Settings

Member Visibility

Theme

On This Page

constructorfromstorageUsagetotransferUsage
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorfromstorageUsagetotransferUsage
\ No newline at end of file diff --git a/docs/classes/CdnUsageStatistics.html b/docs/classes/CdnUsageStatistics.html index 36c0cae25..a626afabf 100644 --- a/docs/classes/CdnUsageStatistics.html +++ b/docs/classes/CdnUsageStatistics.html @@ -1,17 +1,17 @@ CdnUsageStatistics | @bitmovin/api-sdk

Class CdnUsageStatistics

Export

CdnUsageStatistics

-

Constructors

constructor +

Constructors

constructor

Properties

from? storageUsageTotal? to? transferUsageTotal? usage? -

Constructors

constructor

Properties

Optional from

from?: Date

UTC timestamp which marks the beginning of the time period for which the usage statistics are retrieved.

+

Constructors

constructor

Properties

Optional from

from?: Date

UTC timestamp which marks the beginning of the time period for which the usage statistics are retrieved.

Memberof

CdnUsageStatistics

-

Optional storageUsageTotal

storageUsageTotal?: number

Total storage usage in GB per month.

+

Optional storageUsageTotal

storageUsageTotal?: number

Total storage usage in GB per month.

Memberof

CdnUsageStatistics

-

Optional to

to?: Date

UTC timestamp which marks the end of the time period for which the usage statistics are retrieved. The end date is exclusive. For example, if end is 2019-03-28T13:05:00Z, the cost and usage data are retrieved from the start date up to, but not including, 2019-03-28T13:05:00Z.

+

Optional to

to?: Date

UTC timestamp which marks the end of the time period for which the usage statistics are retrieved. The end date is exclusive. For example, if end is 2019-03-28T13:05:00Z, the cost and usage data are retrieved from the start date up to, but not including, 2019-03-28T13:05:00Z.

Memberof

CdnUsageStatistics

-

Optional transferUsageTotal

transferUsageTotal?: number

Total transfer usage in GB.

+

Optional transferUsageTotal

transferUsageTotal?: number

Total transfer usage in GB.

Memberof

CdnUsageStatistics

-

Optional usage

usage?: CdnUsage[]

Memberof

CdnUsageStatistics

-

Settings

Member Visibility

Theme

On This Page

constructorfromstorageUsageTotaltotransferUsageTotalusage
\ No newline at end of file +

Optional usage

usage?: CdnUsage[]

Memberof

CdnUsageStatistics

+

Settings

Member Visibility

Theme

On This Page

constructorfromstorageUsageTotaltotransferUsageTotalusage
\ No newline at end of file diff --git a/docs/classes/Cea608708SubtitleConfiguration.html b/docs/classes/Cea608708SubtitleConfiguration.html index da69df502..29a94fa3c 100644 --- a/docs/classes/Cea608708SubtitleConfiguration.html +++ b/docs/classes/Cea608708SubtitleConfiguration.html @@ -1,8 +1,8 @@ Cea608708SubtitleConfiguration | @bitmovin/api-sdk

Class Cea608708SubtitleConfiguration

Export

Cea608708SubtitleConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

passthroughActivated? passthroughMode? -

Constructors

constructor

Properties

Optional passthroughActivated

passthroughActivated?: boolean

If enabled, CEA 608 an CEA 708 subtitles will be copied from the input video stream to the output video stream. Note: This does not work, if the output framerate is different than the input framerate (except doubling the framerate with deinterlacing per field)

+

Constructors

constructor

Properties

Optional passthroughActivated

passthroughActivated?: boolean

If enabled, CEA 608 an CEA 708 subtitles will be copied from the input video stream to the output video stream. Note: This does not work, if the output framerate is different than the input framerate (except doubling the framerate with deinterlacing per field)

Memberof

Cea608708SubtitleConfiguration

-

Optional passthroughMode

passthroughMode?: PassthroughMode

Memberof

Cea608708SubtitleConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorpassthroughActivatedpassthroughMode
\ No newline at end of file +

Optional passthroughMode

passthroughMode?: PassthroughMode

Memberof

Cea608708SubtitleConfiguration

+

Settings

Member Visibility

Theme

On This Page

constructorpassthroughActivatedpassthroughMode
\ No newline at end of file diff --git a/docs/classes/Cea608CaptionInputStream.html b/docs/classes/Cea608CaptionInputStream.html index 5f7c71b2b..1b5361ba3 100644 --- a/docs/classes/Cea608CaptionInputStream.html +++ b/docs/classes/Cea608CaptionInputStream.html @@ -1,5 +1,5 @@ Cea608CaptionInputStream | @bitmovin/api-sdk

Class Cea608CaptionInputStream

Export

Cea608CaptionInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

channel? createdAt? customData? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional channel

channel?: Cea608ChannelType

The channel number of the subtitle on the respective stream position (required)

+

Constructors

constructor

Properties

Optional channel

channel?: Cea608ChannelType

The channel number of the subtitle on the respective stream position (required)

Memberof

Cea608CaptionInputStream

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

Id of the Input (required)

+

Optional inputId

inputId?: string

Id of the Input (required)

Memberof

Cea608CaptionInputStream

-

Optional inputPath

inputPath?: string

Path to media file (required)

+

Optional inputPath

inputPath?: string

Path to media file (required)

Memberof

Cea608CaptionInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputStreamType = InputStreamType.CAPTION_CEA608

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.CAPTION_CEA608

Discriminator property for InputStream

Memberof

Cea608CaptionInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorchannelcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorchannelcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Cea708CaptionInputStream.html b/docs/classes/Cea708CaptionInputStream.html index 86b13227f..a51e865aa 100644 --- a/docs/classes/Cea708CaptionInputStream.html +++ b/docs/classes/Cea708CaptionInputStream.html @@ -1,5 +1,5 @@ Cea708CaptionInputStream | @bitmovin/api-sdk

Class Cea708CaptionInputStream

Export

Cea708CaptionInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

channel? createdAt? customData? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional channel

channel?: number

The channel number of the subtitle on the respective stream position. Must not be smaller than 1 (required)

+

Constructors

constructor

Properties

Optional channel

channel?: number

The channel number of the subtitle on the respective stream position. Must not be smaller than 1 (required)

Memberof

Cea708CaptionInputStream

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

Id of the Input (required)

+

Optional inputId

inputId?: string

Id of the Input (required)

Memberof

Cea708CaptionInputStream

-

Optional inputPath

inputPath?: string

Path to media file (required)

+

Optional inputPath

inputPath?: string

Path to media file (required)

Memberof

Cea708CaptionInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputStreamType = InputStreamType.CAPTION_CEA708

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.CAPTION_CEA708

Discriminator property for InputStream

Memberof

Cea708CaptionInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorchannelcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorchannelcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/CencDrm.html b/docs/classes/CencDrm.html index 19d55d029..7549799e6 100644 --- a/docs/classes/CencDrm.html +++ b/docs/classes/CencDrm.html @@ -1,5 +1,5 @@ CencDrm | @bitmovin/api-sdk

Class CencDrm

Export

CencDrm

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -19,37 +19,37 @@ widevine? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional enablePiffCompatibility

enablePiffCompatibility?: boolean

Enables compatibility with the Protected Interoperable File Format (PIFF) specification

+

Optional enablePiffCompatibility

enablePiffCompatibility?: boolean

Enables compatibility with the Protected Interoperable File Format (PIFF) specification

Memberof

CencDrm

-

Optional encryptionMode

encryptionMode?: EncryptionMode

The encryption method to use. Default is CTR (required)

+

Optional encryptionMode

encryptionMode?: EncryptionMode

The encryption method to use. Default is CTR (required)

Memberof

CencDrm

-

Optional fairPlay

fairPlay?: CencFairPlay

Configuration for FairPlay DRM

+

Optional fairPlay

fairPlay?: CencFairPlay

Configuration for FairPlay DRM

Memberof

CencDrm

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ivSize

ivSize?: IvSize

Size of the initialization vector

+

Optional ivSize

ivSize?: IvSize

Size of the initialization vector

Memberof

CencDrm

-

Optional key

key?: string

16 byte encryption key, 32 hexadecimal characters (required)

+

Optional key

key?: string

16 byte encryption key, 32 hexadecimal characters (required)

Memberof

CencDrm

-

Optional kid

kid?: string

16 byte encryption key id. Required for any other DRM but FairPlay

+

Optional kid

kid?: string

16 byte encryption key id. Required for any other DRM but FairPlay

Memberof

CencDrm

-

Optional marlin

marlin?: CencMarlin

Configuration for Marlin DRM

+

Optional marlin

marlin?: CencMarlin

Configuration for Marlin DRM

Memberof

CencDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Optional playReady

playReady?: CencPlayReady

Configuration for PlayReady DRM

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Optional playReady

playReady?: CencPlayReady

Configuration for PlayReady DRM

Memberof

CencDrm

-

Readonly type

type: DrmType = DrmType.CENC

Discriminator property for Drm

+

Readonly type

type: DrmType = DrmType.CENC

Discriminator property for Drm

Memberof

CencDrm

-

Optional widevine

widevine?: CencWidevine

Configuration for Widevine DRM

+

Optional widevine

widevine?: CencWidevine

Configuration for Widevine DRM

Memberof

CencDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionenablePiffCompatibilityencryptionModefairPlayidivSizekeykidmarlinmodifiedAtnameoutputsplayReadytypewidevine_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionenablePiffCompatibilityencryptionModefairPlayidivSizekeykidmarlinmodifiedAtnameoutputsplayReadytypewidevine_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/CencFairPlay.html b/docs/classes/CencFairPlay.html index ba987c3d1..33d74568d 100644 --- a/docs/classes/CencFairPlay.html +++ b/docs/classes/CencFairPlay.html @@ -1,9 +1,9 @@ CencFairPlay | @bitmovin/api-sdk

Class CencFairPlay

Export

CencFairPlay

-

Constructors

constructor +

Constructors

constructor

Properties

iv? uri? -

Constructors

constructor

Properties

Optional iv

iv?: string

Initialization vector as hexadecimal string

+

Constructors

constructor

Properties

Optional iv

iv?: string

Initialization vector as hexadecimal string

Memberof

CencFairPlay

-

Optional uri

uri?: string

URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.

+

Optional uri

uri?: string

URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.

Memberof

CencFairPlay

-

Settings

Member Visibility

Theme

On This Page

constructorivuri
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorivuri
\ No newline at end of file diff --git a/docs/classes/CencMarlin.html b/docs/classes/CencMarlin.html index e7ee35e23..996ac6ab8 100644 --- a/docs/classes/CencMarlin.html +++ b/docs/classes/CencMarlin.html @@ -1,3 +1,3 @@ CencMarlin | @bitmovin/api-sdk

Class CencMarlin

Export

CencMarlin

-

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file +

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file diff --git a/docs/classes/CencPlayReady.html b/docs/classes/CencPlayReady.html index 8f13e589a..53a1dc08e 100644 --- a/docs/classes/CencPlayReady.html +++ b/docs/classes/CencPlayReady.html @@ -1,11 +1,11 @@ CencPlayReady | @bitmovin/api-sdk

Class CencPlayReady

Export

CencPlayReady

-

Constructors

constructor +

Constructors

constructor

Properties

additionalInformation? laUrl? pssh? -

Constructors

constructor

Properties

Optional additionalInformation

additionalInformation?: PlayReadyAdditionalInformation

Memberof

CencPlayReady

-

Optional laUrl

laUrl?: string

Url of the license server. Either the laUrl or the pssh needs to be provided.

+

Constructors

constructor

Properties

Optional additionalInformation

additionalInformation?: PlayReadyAdditionalInformation

Memberof

CencPlayReady

+

Optional laUrl

laUrl?: string

Url of the license server. Either the laUrl or the pssh needs to be provided.

Memberof

CencPlayReady

-

Optional pssh

pssh?: string

Base64 encoded pssh payload.

+

Optional pssh

pssh?: string

Base64 encoded pssh payload.

Memberof

CencPlayReady

-

Settings

Member Visibility

Theme

On This Page

constructoradditionalInformationlaUrlpssh
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoradditionalInformationlaUrlpssh
\ No newline at end of file diff --git a/docs/classes/CencWidevine.html b/docs/classes/CencWidevine.html index 0ffc4472e..6a26b1f32 100644 --- a/docs/classes/CencWidevine.html +++ b/docs/classes/CencWidevine.html @@ -1,6 +1,6 @@ CencWidevine | @bitmovin/api-sdk

Class CencWidevine

Export

CencWidevine

-

Constructors

constructor +

Constructors

constructor

Properties

pssh? -

Constructors

constructor

Properties

Optional pssh

pssh?: string

Base64 encoded pssh payload (required)

+

Constructors

constructor

Properties

Optional pssh

pssh?: string

Base64 encoded pssh payload (required)

Memberof

CencWidevine

-

Settings

Member Visibility

Theme

On This Page

constructorpssh
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpssh
\ No newline at end of file diff --git a/docs/classes/CheckOutputPermissionsRequest.html b/docs/classes/CheckOutputPermissionsRequest.html index f6d8efb52..a1ab53733 100644 --- a/docs/classes/CheckOutputPermissionsRequest.html +++ b/docs/classes/CheckOutputPermissionsRequest.html @@ -1,6 +1,6 @@ CheckOutputPermissionsRequest | @bitmovin/api-sdk

Class CheckOutputPermissionsRequest

Export

CheckOutputPermissionsRequest

-

Constructors

constructor +

Constructors

constructor

Properties

path? -

Constructors

constructor

Properties

Optional path

path?: string

The path on the storage for which permissions should be checked. In AWS S3 terminology, this corresponds to a "prefix". To perform the check, an empty test file (WritePermissionTestFile.txt) will be created in this location. Defaults to an empty string, which corresponds to the root directory.

+

Constructors

constructor

Properties

Optional path

path?: string

The path on the storage for which permissions should be checked. In AWS S3 terminology, this corresponds to a "prefix". To perform the check, an empty test file (WritePermissionTestFile.txt) will be created in this location. Defaults to an empty string, which corresponds to the root directory.

Memberof

CheckOutputPermissionsRequest

-

Settings

Member Visibility

Theme

On This Page

constructorpath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpath
\ No newline at end of file diff --git a/docs/classes/CheckOutputPermissionsResponse.html b/docs/classes/CheckOutputPermissionsResponse.html index 9626c2ad2..b6a256031 100644 --- a/docs/classes/CheckOutputPermissionsResponse.html +++ b/docs/classes/CheckOutputPermissionsResponse.html @@ -1,18 +1,18 @@ CheckOutputPermissionsResponse | @bitmovin/api-sdk

Class CheckOutputPermissionsResponse

Export

CheckOutputPermissionsResponse

-

Constructors

constructor +

Constructors

constructor

Properties

failureReason? outputId? outputType? passed? path? -

Constructors

constructor

Properties

Optional failureReason

failureReason?: string

Contains nothing if the check succeeded. Otherwise, contains a message explaining why it failed.

+

Constructors

constructor

Properties

Optional failureReason

failureReason?: string

Contains nothing if the check succeeded. Otherwise, contains a message explaining why it failed.

Memberof

CheckOutputPermissionsResponse

-

Optional outputId

outputId?: string

Id of the output for which permissions were checked

+

Optional outputId

outputId?: string

Id of the output for which permissions were checked

Memberof

CheckOutputPermissionsResponse

-

Optional outputType

outputType?: OutputType

The type of the output for which permissions were checked

+

Optional outputType

outputType?: OutputType

The type of the output for which permissions were checked

Memberof

CheckOutputPermissionsResponse

-

Optional passed

passed?: boolean

Indicates if permissions on the storage are configured correctly to be used as output target by the Bitmovin encoder. If "false", failureReason will provide additional information.

+

Optional passed

passed?: boolean

Indicates if permissions on the storage are configured correctly to be used as output target by the Bitmovin encoder. If "false", failureReason will provide additional information.

Memberof

CheckOutputPermissionsResponse

-

Optional path

path?: string

The path on the storage for which permissions were checked. In AWS S3 terminology, this corresponds to a "prefix". An empty string corresponds to the root directory.

+

Optional path

path?: string

The path on the storage for which permissions were checked. In AWS S3 terminology, this corresponds to a "prefix". An empty string corresponds to the root directory.

Memberof

CheckOutputPermissionsResponse

-

Settings

Member Visibility

Theme

On This Page

constructorfailureReasonoutputIdoutputTypepassedpath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorfailureReasonoutputIdoutputTypepassedpath
\ No newline at end of file diff --git a/docs/classes/ChunkedTextMuxing.html b/docs/classes/ChunkedTextMuxing.html index a14543bd7..dd4bbd654 100644 --- a/docs/classes/ChunkedTextMuxing.html +++ b/docs/classes/ChunkedTextMuxing.html @@ -1,5 +1,5 @@ ChunkedTextMuxing | @bitmovin/api-sdk

Class ChunkedTextMuxing

Export

ChunkedTextMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -21,40 +21,40 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Length of the segments in seconds (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Length of the segments in seconds (required)

Memberof

ChunkedTextMuxing

-

Optional segmentNaming

segmentNaming?: string

Segment naming policy

+

Optional segmentNaming

segmentNaming?: string

Segment naming policy

Memberof

ChunkedTextMuxing

-

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

+

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

Memberof

ChunkedTextMuxing

-

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

+

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

Memberof

ChunkedTextMuxing

-

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. This only affects streams with WebVttConfiguration. If set, the X-TIMESTAMP-MAP will be added as described in the HLS specification. For example, if set to 10 seconds, X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000 will be added after each WEBVTT header. The default for ChunkedTextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for startOffset for TsMuxings and ProgressiveTsMuxings is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same startOffset.

+

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. This only affects streams with WebVttConfiguration. If set, the X-TIMESTAMP-MAP will be added as described in the HLS specification. For example, if set to 10 seconds, X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000 will be added after each WEBVTT header. The default for ChunkedTextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for startOffset for TsMuxings and ProgressiveTsMuxings is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same startOffset.

Memberof

ChunkedTextMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.CHUNKED_TEXT

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.CHUNKED_TEXT

Discriminator property for Muxing

Memberof

ChunkedTextMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ClearKeyDrm.html b/docs/classes/ClearKeyDrm.html index 6a34f49c5..cd56b5f95 100644 --- a/docs/classes/ClearKeyDrm.html +++ b/docs/classes/ClearKeyDrm.html @@ -1,5 +1,5 @@ ClearKeyDrm | @bitmovin/api-sdk

Class ClearKeyDrm

Export

ClearKeyDrm

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,23 +12,23 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional key

key?: string

16 byte encryption key, 32 hexadecimal characters (required)

+

Optional key

key?: string

16 byte encryption key, 32 hexadecimal characters (required)

Memberof

ClearKeyDrm

-

Optional kid

kid?: string

16 byte key id (required)

+

Optional kid

kid?: string

16 byte key id (required)

Memberof

ClearKeyDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Readonly type

type: DrmType = DrmType.CLEARKEY

Discriminator property for Drm

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Readonly type

type: DrmType = DrmType.CLEARKEY

Discriminator property for Drm

Memberof

ClearKeyDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidkeykidmodifiedAtnameoutputstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidkeykidmodifiedAtnameoutputstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ClosedCaptionsMediaInfo.html b/docs/classes/ClosedCaptionsMediaInfo.html index 22f79c43b..8040d2438 100644 --- a/docs/classes/ClosedCaptionsMediaInfo.html +++ b/docs/classes/ClosedCaptionsMediaInfo.html @@ -1,5 +1,5 @@ ClosedCaptionsMediaInfo | @bitmovin/api-sdk

Class ClosedCaptionsMediaInfo

Export

ClosedCaptionsMediaInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assocLanguage? autoselect? characteristics? @@ -17,38 +17,38 @@ segmentPath? startSegmentNumber? streamId? -

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

+

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

Memberof

BasicMediaInfo

-

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

+

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

Memberof

BasicMediaInfo

-

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

+

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

Memberof

BasicMediaInfo

-

Optional drmId

drmId?: string

Id of the DRM.

+

Optional drmId

drmId?: string

Id of the DRM.

Memberof

SegmentsMediaInfo

-

Optional encodingId

encodingId?: string

Id of the encoding. (required)

+

Optional encodingId

encodingId?: string

Id of the encoding. (required)

Memberof

SegmentsMediaInfo

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

Memberof

SegmentsMediaInfo

-

Optional forced

forced?: boolean

A value of true indicates that the Rendition contains content which is considered essential to play.

+

Optional forced

forced?: boolean

A value of true indicates that the Rendition contains content which is considered essential to play.

Memberof

ClosedCaptionsMediaInfo

-

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

+

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

Memberof

BasicMediaInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional instreamId

instreamId?: string

Specifies a Rendition within the segments in the Media Playlist. (See HLS spec 4.3.4.1. EXT-X-MEDIA INSTREAM-ID) (required)

+

Optional instreamId

instreamId?: string

Specifies a Rendition within the segments in the Media Playlist. (See HLS spec 4.3.4.1. EXT-X-MEDIA INSTREAM-ID) (required)

Memberof

ClosedCaptionsMediaInfo

-

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

+

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

Memberof

BasicMediaInfo

-

Optional language

language?: string

Primary language in the rendition.

+

Optional language

language?: string

Primary language in the rendition.

Memberof

BasicMediaInfo

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

SegmentsMediaInfo

-

Optional name

name?: string

Human readable description of the rendition. (required)

+

Optional name

name?: string

Human readable description of the rendition. (required)

Memberof

BasicMediaInfo

-

Optional segmentPath

segmentPath?: string

Path to segments. (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. (required)

Memberof

SegmentsMediaInfo

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

Memberof

SegmentsMediaInfo

-

Optional streamId

streamId?: string

Id of the stream. (required)

+

Optional streamId

streamId?: string

Id of the stream. (required)

Memberof

SegmentsMediaInfo

-

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumberforcedgroupIdidinstreamIdisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumberforcedgroupIdidinstreamIdisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamId
\ No newline at end of file diff --git a/docs/classes/CmafMuxing.html b/docs/classes/CmafMuxing.html index 87453167f..7d22fffd3 100644 --- a/docs/classes/CmafMuxing.html +++ b/docs/classes/CmafMuxing.html @@ -1,5 +1,5 @@ CmafMuxing | @bitmovin/api-sdk

Class CmafMuxing

Export

CmafMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -23,44 +23,44 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional framesPerCmafChunk

framesPerCmafChunk?: number

Number of media frames per CMAF chunk. Defaults to: Length of a segment in frames. Minimum: 1. Maximum: Length of a segment in frames.

+

Optional framesPerCmafChunk

framesPerCmafChunk?: number

Number of media frames per CMAF chunk. Defaults to: Length of a segment in frames. Minimum: 1. Maximum: Length of a segment in frames.

Memberof

CmafMuxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional initSegmentName

initSegmentName?: string

Init segment name

+

Optional initSegmentName

initSegmentName?: string

Init segment name

Memberof

CmafMuxing

-

Optional initSegmentNameTemplate

initSegmentNameTemplate?: string

Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.

+

Optional initSegmentNameTemplate

initSegmentNameTemplate?: string

Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.

Memberof

CmafMuxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds (required)

Memberof

CmafMuxing

-

Optional segmentNaming

segmentNaming?: string

Segment naming policy

+

Optional segmentNaming

segmentNaming?: string

Segment naming policy

Memberof

CmafMuxing

-

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

+

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

Memberof

CmafMuxing

-

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

+

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

Memberof

CmafMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.CMAF

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.CMAF

Discriminator property for Muxing

Memberof

CmafMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionframesPerCmafChunkidignoredByinitSegmentNameinitSegmentNameTemplatemaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionframesPerCmafChunkidignoredByinitSegmentNameinitSegmentNameTemplatemaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/CodecConfigTypeResponse.html b/docs/classes/CodecConfigTypeResponse.html index 273d8a8c5..212ef0fc2 100644 --- a/docs/classes/CodecConfigTypeResponse.html +++ b/docs/classes/CodecConfigTypeResponse.html @@ -1,6 +1,6 @@ CodecConfigTypeResponse | @bitmovin/api-sdk

Class CodecConfigTypeResponse

Export

CodecConfigTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: CodecConfigType

The type of the codec config

+

Constructors

constructor

Properties

Optional type

type?: CodecConfigType

The type of the codec config

Memberof

CodecConfigTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/CodecConfiguration.html b/docs/classes/CodecConfiguration.html index e67ba1bd0..2a284a8c1 100644 --- a/docs/classes/CodecConfiguration.html +++ b/docs/classes/CodecConfiguration.html @@ -1,5 +1,5 @@ CodecConfiguration | @bitmovin/api-sdk

Class CodecConfiguration

Export

CodecConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,16 +8,16 @@ name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ColorConfig.html b/docs/classes/ColorConfig.html index 4a3eb442d..8567be015 100644 --- a/docs/classes/ColorConfig.html +++ b/docs/classes/ColorConfig.html @@ -1,5 +1,5 @@ ColorConfig | @bitmovin/api-sdk

Class ColorConfig

Export

ColorConfig

-

Constructors

constructor +

Constructors

constructor

Properties

chromaLocation? colorPrimaries? colorRange? @@ -14,32 +14,32 @@ inputColorRange? inputColorSpace? inputColorTransfer? -

Constructors

constructor

Properties

Optional chromaLocation

chromaLocation?: ChromaLocation

The chroma location to be applied

+

Constructors

constructor

Properties

Optional chromaLocation

chromaLocation?: ChromaLocation

The chroma location to be applied

Memberof

ColorConfig

-

Optional colorPrimaries

colorPrimaries?: ColorPrimaries

The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.

+

Optional colorPrimaries

colorPrimaries?: ColorPrimaries

The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.

Memberof

ColorConfig

-

Optional colorRange

colorRange?: ColorRange

The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.

+

Optional colorRange

colorRange?: ColorRange

The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.

Memberof

ColorConfig

-

Optional colorSpace

colorSpace?: ColorSpace

The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.

+

Optional colorSpace

colorSpace?: ColorSpace

The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.

Memberof

ColorConfig

-

Optional colorTransfer

colorTransfer?: ColorTransfer

The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.

+

Optional colorTransfer

colorTransfer?: ColorTransfer

The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.

Memberof

ColorConfig

-

Optional copyChromaLocationFlag

copyChromaLocationFlag?: boolean

Copy the chroma location setting from the input source

+

Optional copyChromaLocationFlag

copyChromaLocationFlag?: boolean

Copy the chroma location setting from the input source

Memberof

ColorConfig

-

Optional copyColorPrimariesFlag

copyColorPrimariesFlag?: boolean

Copy the color primaries setting from the input source

+

Optional copyColorPrimariesFlag

copyColorPrimariesFlag?: boolean

Copy the color primaries setting from the input source

Memberof

ColorConfig

-

Optional copyColorRangeFlag

copyColorRangeFlag?: boolean

Copy the color range setting from the input source

+

Optional copyColorRangeFlag

copyColorRangeFlag?: boolean

Copy the color range setting from the input source

Memberof

ColorConfig

-

Optional copyColorSpaceFlag

copyColorSpaceFlag?: boolean

Copy the color space setting from the input source

+

Optional copyColorSpaceFlag

copyColorSpaceFlag?: boolean

Copy the color space setting from the input source

Memberof

ColorConfig

-

Optional copyColorTransferFlag

copyColorTransferFlag?: boolean

Copy the color transfer setting from the input source

+

Optional copyColorTransferFlag

copyColorTransferFlag?: boolean

Copy the color transfer setting from the input source

Memberof

ColorConfig

-

Optional inputColorPrimaries

inputColorPrimaries?: InputColorPrimaries

Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.

+

Optional inputColorPrimaries

inputColorPrimaries?: InputColorPrimaries

Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.

Memberof

ColorConfig

-

Optional inputColorRange

inputColorRange?: InputColorRange

Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.

+

Optional inputColorRange

inputColorRange?: InputColorRange

Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.

Memberof

ColorConfig

-

Optional inputColorSpace

inputColorSpace?: InputColorSpace

Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.

+

Optional inputColorSpace

inputColorSpace?: InputColorSpace

Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.

Memberof

ColorConfig

-

Optional inputColorTransfer

inputColorTransfer?: InputColorTransfer

Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.

+

Optional inputColorTransfer

inputColorTransfer?: InputColorTransfer

Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.

Memberof

ColorConfig

-

Settings

Member Visibility

Theme

On This Page

constructorchromaLocationcolorPrimariescolorRangecolorSpacecolorTransfercopyChromaLocationFlagcopyColorPrimariesFlagcopyColorRangeFlagcopyColorSpaceFlagcopyColorTransferFlaginputColorPrimariesinputColorRangeinputColorSpaceinputColorTransfer
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorchromaLocationcolorPrimariescolorRangecolorSpacecolorTransfercopyChromaLocationFlagcopyColorPrimariesFlagcopyColorRangeFlagcopyColorSpaceFlagcopyColorTransferFlaginputColorPrimariesinputColorRangeinputColorSpaceinputColorTransfer
\ No newline at end of file diff --git a/docs/classes/ConcatenationInputConfiguration.html b/docs/classes/ConcatenationInputConfiguration.html index 3053be65a..2fb33c910 100644 --- a/docs/classes/ConcatenationInputConfiguration.html +++ b/docs/classes/ConcatenationInputConfiguration.html @@ -1,21 +1,21 @@ ConcatenationInputConfiguration | @bitmovin/api-sdk

Class ConcatenationInputConfiguration

Export

ConcatenationInputConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

aspectMode? inputStreamId? isMain? paddingAfter? paddingBefore? position? -

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: AspectMode

Specifies the aspect mode that is used when adapting to the main input stream's aspect ratio

+

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: AspectMode

Specifies the aspect mode that is used when adapting to the main input stream's aspect ratio

Memberof

ConcatenationInputConfiguration

-

Optional inputStreamId

inputStreamId?: string

The ID of the input stream to be concatenated. This can be an ingest input stream or a trimming input stream (required)

+

Optional inputStreamId

inputStreamId?: string

The ID of the input stream to be concatenated. This can be an ingest input stream or a trimming input stream (required)

Memberof

ConcatenationInputConfiguration

-

Optional isMain

isMain?: boolean

Exactly one input stream of a concatenation must have this set to true, which will be used as reference for scaling, aspect ratio, FPS, sample rate, etc.

+

Optional isMain

isMain?: boolean

Exactly one input stream of a concatenation must have this set to true, which will be used as reference for scaling, aspect ratio, FPS, sample rate, etc.

Memberof

ConcatenationInputConfiguration

-

Optional paddingAfter

paddingAfter?: PaddingSequence

Inserts a padding sequence (black frames and/or silent audio) after the input stream.

+

Optional paddingAfter

paddingAfter?: PaddingSequence

Inserts a padding sequence (black frames and/or silent audio) after the input stream.

Memberof

ConcatenationInputConfiguration

-

Optional paddingBefore

paddingBefore?: PaddingSequence

Inserts a padding sequence (black frames and/or silent audio) before the input stream.

+

Optional paddingBefore

paddingBefore?: PaddingSequence

Inserts a padding sequence (black frames and/or silent audio) before the input stream.

Memberof

ConcatenationInputConfiguration

-

Optional position

position?: number

A unique integer value that determines concatenation order (required)

+

Optional position

position?: number

A unique integer value that determines concatenation order (required)

Memberof

ConcatenationInputConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructoraspectModeinputStreamIdisMainpaddingAfterpaddingBeforeposition
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraspectModeinputStreamIdisMainpaddingAfterpaddingBeforeposition
\ No newline at end of file diff --git a/docs/classes/ConcatenationInputStream.html b/docs/classes/ConcatenationInputStream.html index 9112a0800..a98ab0e3b 100644 --- a/docs/classes/ConcatenationInputStream.html +++ b/docs/classes/ConcatenationInputStream.html @@ -1,5 +1,5 @@ ConcatenationInputStream | @bitmovin/api-sdk

Class ConcatenationInputStream

Export

ConcatenationInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

concatenation? createdAt? customData? @@ -10,20 +10,20 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional concatenation

concatenation?: ConcatenationInputConfiguration[]

Concatenation configuration for the output of this stream

+

Constructors

constructor

Properties

Optional concatenation

concatenation?: ConcatenationInputConfiguration[]

Concatenation configuration for the output of this stream

Memberof

ConcatenationInputStream

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputStreamType = InputStreamType.CONCATENATION

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.CONCATENATION

Discriminator property for InputStream

Memberof

ConcatenationInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconcatenationcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconcatenationcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Condition.html b/docs/classes/Condition.html index 1257e50f2..94d8d0ddd 100644 --- a/docs/classes/Condition.html +++ b/docs/classes/Condition.html @@ -1,17 +1,17 @@ Condition | @bitmovin/api-sdk

Class Condition

Export

Condition

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

attribute? operator? type value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional attribute

attribute?: string

The attribute that should be used for the evaluation. Valid values include, depending on the context: - HEIGHT - WIDTH - BITRATE - FPS - ASPECTRATIO - INPUTSTREAM - LANGUAGE - CHANNELFORMAT - CHANNELLAYOUT - STREAMCOUNT - AUDIOSTREAMCOUNT - VIDEOSTREAMCOUNT - DURATION - ROTATION (required)

+

Constructors

constructor

Properties

Optional attribute

attribute?: string

The attribute that should be used for the evaluation. Valid values include, depending on the context: - HEIGHT - WIDTH - BITRATE - FPS - ASPECTRATIO - INPUTSTREAM - LANGUAGE - CHANNELFORMAT - CHANNELLAYOUT - STREAMCOUNT - AUDIOSTREAMCOUNT - VIDEOSTREAMCOUNT - DURATION - ROTATION (required)

Memberof

Condition

-

Optional operator

operator?: ConditionOperator

The operator that should be used for the evaluation (required)

+

Optional operator

operator?: ConditionOperator

The operator that should be used for the evaluation (required)

Memberof

Condition

-

Readonly type

type: ConditionType = ConditionType.CONDITION

Discriminator property for AbstractCondition

+

Readonly type

type: ConditionType = ConditionType.CONDITION

Discriminator property for AbstractCondition

Memberof

Condition

-

Optional value

value?: string

The value that should be used for comparison (required)

+

Optional value

value?: string

The value that should be used for comparison (required)

Memberof

Condition

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorattributeoperatortypevalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorattributeoperatortypevalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ConformFilter.html b/docs/classes/ConformFilter.html index 41b5e1627..c3f1abefa 100644 --- a/docs/classes/ConformFilter.html +++ b/docs/classes/ConformFilter.html @@ -1,5 +1,5 @@ ConformFilter | @bitmovin/api-sdk

Class ConformFilter

Export

ConformFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -10,20 +10,20 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional targetFps

targetFps?: number

The FPS the input should be changed to.

+

Optional targetFps

targetFps?: number

The FPS the input should be changed to.

Memberof

ConformFilter

-

Readonly type

type: FilterType = FilterType.CONFORM

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.CONFORM

Discriminator property for Filter

Memberof

ConformFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametargetFpstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametargetFpstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ConsoleLogger.html b/docs/classes/ConsoleLogger.html index 5147779ff..983233235 100644 --- a/docs/classes/ConsoleLogger.html +++ b/docs/classes/ConsoleLogger.html @@ -1,4 +1,4 @@ -ConsoleLogger | @bitmovin/api-sdk

Class ConsoleLogger

Implements

  • Logger

Constructors

constructor +ConsoleLogger | @bitmovin/api-sdk

Class ConsoleLogger

Implements

  • Logger

Constructors

constructor

Methods

logRequest logResponse -

Constructors

constructor

Methods

logRequest

logResponse

Settings

Member Visibility

Theme

On This Page

constructorlogRequestlogResponse
\ No newline at end of file +

Constructors

constructor

Methods

logRequest

logResponse

Settings

Member Visibility

Theme

On This Page

constructorlogRequestlogResponse
\ No newline at end of file diff --git a/docs/classes/ContentProtection.html b/docs/classes/ContentProtection.html index 22221fb7f..915c62c02 100644 --- a/docs/classes/ContentProtection.html +++ b/docs/classes/ContentProtection.html @@ -1,5 +1,5 @@ ContentProtection | @bitmovin/api-sdk

Class ContentProtection

Export

ContentProtection

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? drmId? encodingId? @@ -8,16 +8,16 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional drmId

drmId?: string

DRM Id (required)

+

Optional drmId

drmId?: string

DRM Id (required)

Memberof

ContentProtection

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.CONTENT_PROTECTION

Discriminator property for DashRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.CONTENT_PROTECTION

Discriminator property for DashRepresentation

Memberof

ContentProtection

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIddrmIdencodingIdidmuxingIdtypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIddrmIdencodingIdidmuxingIdtypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ConvertSccCaption.html b/docs/classes/ConvertSccCaption.html index 3121c1435..8b1110b98 100644 --- a/docs/classes/ConvertSccCaption.html +++ b/docs/classes/ConvertSccCaption.html @@ -1,5 +1,5 @@ ConvertSccCaption | @bitmovin/api-sdk

Class ConvertSccCaption

Export

ConvertSccCaption

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -11,24 +11,24 @@ outputFormat? outputs? webVttSettings? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional fileName

fileName?: string

Name of the captions file (required)

+

Optional fileName

fileName?: string

Name of the captions file (required)

Memberof

ConvertSccCaption

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional input

input?: InputPath

The input location to get the scc file from (required)

+

Optional input

input?: InputPath

The input location to get the scc file from (required)

Memberof

ConvertSccCaption

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputFormat

outputFormat?: WEBVTT

Memberof

ConvertSccCaption

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

ConvertSccCaption

-

Optional webVttSettings

webVttSettings?: ConvertSccCaptionWebVttSettings

Optional settings when converting SCC to WebVTT

+

Optional outputFormat

outputFormat?: WEBVTT

Memberof

ConvertSccCaption

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

ConvertSccCaption

+

Optional webVttSettings

webVttSettings?: ConvertSccCaptionWebVttSettings

Optional settings when converting SCC to WebVTT

Memberof

ConvertSccCaption

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionfileNameidinputmodifiedAtnameoutputFormatoutputswebVttSettings
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionfileNameidinputmodifiedAtnameoutputFormatoutputswebVttSettings
\ No newline at end of file diff --git a/docs/classes/ConvertSccCaptionWebVttSettings.html b/docs/classes/ConvertSccCaptionWebVttSettings.html index b5a78551b..b66df51ca 100644 --- a/docs/classes/ConvertSccCaptionWebVttSettings.html +++ b/docs/classes/ConvertSccCaptionWebVttSettings.html @@ -1,11 +1,11 @@ ConvertSccCaptionWebVttSettings | @bitmovin/api-sdk

Class ConvertSccCaptionWebVttSettings

Export

ConvertSccCaptionWebVttSettings

-

Constructors

constructor +

Constructors

constructor

Properties

positionMode? removeColor? removeFlash? -

Constructors

constructor

Properties

Optional positionMode

positionMode?: ConvertSccPositionMode

Memberof

ConvertSccCaptionWebVttSettings

-

Optional removeColor

removeColor?: boolean

Remove color information when converting SCC to WebVTT

+

Constructors

constructor

Properties

Optional positionMode

positionMode?: ConvertSccPositionMode

Memberof

ConvertSccCaptionWebVttSettings

+

Optional removeColor

removeColor?: boolean

Remove color information when converting SCC to WebVTT

Memberof

ConvertSccCaptionWebVttSettings

-

Optional removeFlash

removeFlash?: boolean

Remove flash (blinking) information when converting SCC to WebVTT

+

Optional removeFlash

removeFlash?: boolean

Remove flash (blinking) information when converting SCC to WebVTT

Memberof

ConvertSccCaptionWebVttSettings

-

Settings

Member Visibility

Theme

On This Page

constructorpositionModeremoveColorremoveFlash
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpositionModeremoveColorremoveFlash
\ No newline at end of file diff --git a/docs/classes/CropFilter.html b/docs/classes/CropFilter.html index bd4d276be..0ca684ad8 100644 --- a/docs/classes/CropFilter.html +++ b/docs/classes/CropFilter.html @@ -1,5 +1,5 @@ CropFilter | @bitmovin/api-sdk

Class CropFilter

Export

CropFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bottom? createdAt? customData? @@ -14,27 +14,27 @@ unit? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bottom

bottom?: number

Amount of pixels that will be cropped of the input video from the bottom. Must be zero or a positive value.

+

Constructors

constructor

Properties

Optional bottom

bottom?: number

Amount of pixels that will be cropped of the input video from the bottom. Must be zero or a positive value.

Memberof

CropFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional left

left?: number

Amount of pixels that will be cropped of the input video from the left side. Must be zero or a positive value.

+

Optional left

left?: number

Amount of pixels that will be cropped of the input video from the left side. Must be zero or a positive value.

Memberof

CropFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional right

right?: number

Amount of pixels that will be cropped of the input video from the right side. Must be zero or a positive value.

+

Optional right

right?: number

Amount of pixels that will be cropped of the input video from the right side. Must be zero or a positive value.

Memberof

CropFilter

-

Optional top

top?: number

Amount of pixels that will be cropped of the input video from the top. Must be zero or a positive value.

+

Optional top

top?: number

Amount of pixels that will be cropped of the input video from the top. Must be zero or a positive value.

Memberof

CropFilter

-

Readonly type

type: FilterType = FilterType.CROP

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.CROP

Discriminator property for Filter

Memberof

CropFilter

-

Optional unit

unit?: PositionUnit

Memberof

CropFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbottomcreatedAtcustomDatadescriptionidleftmodifiedAtnamerighttoptypeunit_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional unit

unit?: PositionUnit

Memberof

CropFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbottomcreatedAtcustomDatadescriptionidleftmodifiedAtnamerighttoptypeunit_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/CustomAttribute.html b/docs/classes/CustomAttribute.html index b4236b4c8..ffe8652f5 100644 --- a/docs/classes/CustomAttribute.html +++ b/docs/classes/CustomAttribute.html @@ -1,9 +1,9 @@ CustomAttribute | @bitmovin/api-sdk

Class CustomAttribute

Export

CustomAttribute

-

Constructors

constructor +

Constructors

constructor

Properties

key? value? -

Constructors

constructor

Properties

Optional key

key?: string

unique string identifier for the custom attribute (required)

+

Constructors

constructor

Properties

Optional key

key?: string

unique string identifier for the custom attribute (required)

Memberof

CustomAttribute

-

Optional value

value?: string

value of the custom attribute

+

Optional value

value?: string

value of the custom attribute

Memberof

CustomAttribute

-

Settings

Member Visibility

Theme

On This Page

constructorkeyvalue
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorkeyvalue
\ No newline at end of file diff --git a/docs/classes/CustomData.html b/docs/classes/CustomData.html index 5ef73d248..a6da3845b 100644 --- a/docs/classes/CustomData.html +++ b/docs/classes/CustomData.html @@ -1,9 +1,9 @@ CustomData | @bitmovin/api-sdk

Class CustomData

Export

CustomData

-

Constructors

constructor +

Constructors

constructor

Properties

createdAt? customData? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

CustomData

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold a custom JSON object.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold a custom JSON object.

Type declaration

  • [key: string]: any

Memberof

CustomData

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomData
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomData
\ No newline at end of file diff --git a/docs/classes/CustomPlayerBuildDetails.html b/docs/classes/CustomPlayerBuildDetails.html index 1ab9caee7..f6b33eba9 100644 --- a/docs/classes/CustomPlayerBuildDetails.html +++ b/docs/classes/CustomPlayerBuildDetails.html @@ -1,5 +1,5 @@ CustomPlayerBuildDetails | @bitmovin/api-sdk

Class CustomPlayerBuildDetails

Export

CustomPlayerBuildDetails

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,20 +8,20 @@ modifiedAt? name? playerVersion? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional domains

domains?: string[]

The domains that the player is locked to. If not set the player will only work with 'localhost'. Not more than 49 additional domains can be added. (required)

+

Optional domains

domains?: string[]

The domains that the player is locked to. If not set the player will only work with 'localhost'. Not more than 49 additional domains can be added. (required)

Memberof

CustomPlayerBuildDetails

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional playerVersion

playerVersion?: string

The player version that should be used for the custom player build. If not set the 'latest' version is used. (required)

+

Optional playerVersion

playerVersion?: string

The player version that should be used for the custom player build. If not set the 'latest' version is used. (required)

Memberof

CustomPlayerBuildDetails

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptiondomainsidmodifiedAtnameplayerVersion
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptiondomainsidmodifiedAtnameplayerVersion
\ No newline at end of file diff --git a/docs/classes/CustomPlayerBuildDownload.html b/docs/classes/CustomPlayerBuildDownload.html index 3fb2b0e4b..3d4049b41 100644 --- a/docs/classes/CustomPlayerBuildDownload.html +++ b/docs/classes/CustomPlayerBuildDownload.html @@ -1,10 +1,10 @@ CustomPlayerBuildDownload | @bitmovin/api-sdk

Class CustomPlayerBuildDownload

Custom player download information

Export

CustomPlayerBuildDownload

-

Constructors

constructor +

Constructors

constructor

Properties

downloadLink? expiresAt? -

Constructors

constructor

Properties

Optional downloadLink

downloadLink?: string

The link to download the custom built player (required)

+

Constructors

constructor

Properties

Optional downloadLink

downloadLink?: string

The link to download the custom built player (required)

Memberof

CustomPlayerBuildDownload

-

Optional expiresAt

expiresAt?: Date

Until this date the download link is valid and can be downloaded. (required)

+

Optional expiresAt

expiresAt?: Date

Until this date the download link is valid and can be downloaded. (required)

Memberof

CustomPlayerBuildDownload

-

Settings

Member Visibility

Theme

On This Page

constructordownloadLinkexpiresAt
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordownloadLinkexpiresAt
\ No newline at end of file diff --git a/docs/classes/CustomPlayerBuildStatus.html b/docs/classes/CustomPlayerBuildStatus.html index 9c3e9e84b..de0f89e9d 100644 --- a/docs/classes/CustomPlayerBuildStatus.html +++ b/docs/classes/CustomPlayerBuildStatus.html @@ -1,16 +1,16 @@ CustomPlayerBuildStatus | @bitmovin/api-sdk

Class CustomPlayerBuildStatus

Export

CustomPlayerBuildStatus

-

Constructors

constructor +

Constructors

constructor

Properties

eta? messages? progress? status? subtasks? -

Constructors

constructor

Properties

Optional eta

eta?: number

The estimated time span of the custom player build in seconds.

+

Constructors

constructor

Properties

Optional eta

eta?: number

The estimated time span of the custom player build in seconds.

Memberof

CustomPlayerBuildStatus

-

Optional messages

messages?: Message

Memberof

CustomPlayerBuildStatus

-

Optional progress

progress?: number

The actual progress of the custom player build. (required)

+

Optional messages

messages?: Message

Memberof

CustomPlayerBuildStatus

+

Optional progress

progress?: number

The actual progress of the custom player build. (required)

Memberof

CustomPlayerBuildStatus

-

Optional status

status?: Status

Status of the player build (required)

+

Optional status

status?: Status

Status of the player build (required)

Memberof

CustomPlayerBuildStatus

-

Optional subtasks

subtasks?: string

Memberof

CustomPlayerBuildStatus

-

Settings

Member Visibility

Theme

On This Page

constructoretamessagesprogressstatussubtasks
\ No newline at end of file +

Optional subtasks

subtasks?: string

Memberof

CustomPlayerBuildStatus

+

Settings

Member Visibility

Theme

On This Page

constructoretamessagesprogressstatussubtasks
\ No newline at end of file diff --git a/docs/classes/CustomTag.html b/docs/classes/CustomTag.html index 88bd9c1bd..d30d70992 100644 --- a/docs/classes/CustomTag.html +++ b/docs/classes/CustomTag.html @@ -1,5 +1,5 @@ CustomTag | @bitmovin/api-sdk

Class CustomTag

Export

CustomTag

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? data? @@ -11,26 +11,26 @@ positionMode? segment? time? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional data

data?: string

The data to be contained in the custom tag. (required)

+

Optional data

data?: string

The data to be contained in the custom tag. (required)

Memberof

CustomTag

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional keyframeId

keyframeId?: string

Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode.

+

Optional keyframeId

keyframeId?: string

Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode.

Memberof

CustomTag

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional positionMode

positionMode?: PositionMode

The positioning mode that should be used when inserting the placement opportunity (required)

+

Optional positionMode

positionMode?: PositionMode

The positioning mode that should be used when inserting the placement opportunity (required)

Memberof

CustomTag

-

Optional segment

segment?: number

The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode.

+

Optional segment

segment?: number

The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode.

Memberof

CustomTag

-

Optional time

time?: number

Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode.

+

Optional time

time?: number

Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode.

Memberof

CustomTag

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadatadescriptionidkeyframeIdmodifiedAtnamepositionModesegmenttime
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadatadescriptionidkeyframeIdmodifiedAtnamepositionModesegmenttime
\ No newline at end of file diff --git a/docs/classes/CustomWebPlayerBuildDomain.html b/docs/classes/CustomWebPlayerBuildDomain.html index 65766529c..e9ca604ca 100644 --- a/docs/classes/CustomWebPlayerBuildDomain.html +++ b/docs/classes/CustomWebPlayerBuildDomain.html @@ -1,5 +1,5 @@ CustomWebPlayerBuildDomain | @bitmovin/api-sdk

Class CustomWebPlayerBuildDomain

Export

CustomWebPlayerBuildDomain

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -7,18 +7,18 @@ id? modifiedAt? name? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional domain

domain?: string

Domain where the player is allowed to play (required)

+

Optional domain

domain?: string

Domain where the player is allowed to play (required)

Memberof

CustomWebPlayerBuildDomain

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptiondomainidmodifiedAtname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptiondomainidmodifiedAtname
\ No newline at end of file diff --git a/docs/classes/CustomXmlElement.html b/docs/classes/CustomXmlElement.html index ee2c2b07c..7e03e6ba2 100644 --- a/docs/classes/CustomXmlElement.html +++ b/docs/classes/CustomXmlElement.html @@ -1,9 +1,9 @@ CustomXmlElement | @bitmovin/api-sdk

Class CustomXmlElement

Export

CustomXmlElement

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

data? id? -

Constructors

constructor

Properties

Optional data

data?: string

String representation of the XML element (required)

+

Constructors

constructor

Properties

Optional data

data?: string

String representation of the XML element (required)

Memberof

CustomXmlElement

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Settings

Member Visibility

Theme

On This Page

constructordataid
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordataid
\ No newline at end of file diff --git a/docs/classes/DailyStatistics.html b/docs/classes/DailyStatistics.html index 2ca9a024d..b1efc6c46 100644 --- a/docs/classes/DailyStatistics.html +++ b/docs/classes/DailyStatistics.html @@ -1,5 +1,5 @@ DailyStatistics | @bitmovin/api-sdk

Class DailyStatistics

Export

DailyStatistics

-

Constructors

constructor +

Constructors

constructor

Properties

billableEgressBytes? billableEncodingMinutes? billableFeatureMinutes? @@ -9,21 +9,21 @@ date? label? timeEncoded? -

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Memberof

DailyStatistics

-

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Billable minutes for each encoding configuration.

+

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Memberof

DailyStatistics

+

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Billable minutes for each encoding configuration.

Memberof

DailyStatistics

-

Optional billableFeatureMinutes

billableFeatureMinutes?: BillableEncodingFeatureMinutes[]

Billable minutes for features

+

Optional billableFeatureMinutes

billableFeatureMinutes?: BillableEncodingFeatureMinutes[]

Billable minutes for features

Memberof

DailyStatistics

-

Optional billableMinutes

billableMinutes?: number

The billable minutes.

+

Optional billableMinutes

billableMinutes?: number

The billable minutes.

Memberof

DailyStatistics

-

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for muxings.

+

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for muxings.

Memberof

DailyStatistics

-

Optional bytesEncoded

bytesEncoded?: number

Bytes encoded. (required)

+

Optional bytesEncoded

bytesEncoded?: number

Bytes encoded. (required)

Memberof

DailyStatistics

-

Optional date

date?: Date

Date for the shown data. Format: yyyy-MM-dd (required)

+

Optional date

date?: Date

Date for the shown data. Format: yyyy-MM-dd (required)

Memberof

DailyStatistics

-

Optional label

label?: string

Label identifier.

+

Optional label

label?: string

Label identifier.

Memberof

DailyStatistics

-

Optional timeEncoded

timeEncoded?: number

Time in seconds encoded for this day. (required)

+

Optional timeEncoded

timeEncoded?: number

Time in seconds encoded for this day. (required)

Memberof

DailyStatistics

-

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableMinutesbillableTransmuxingMinutesbytesEncodeddatelabeltimeEncoded
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableMinutesbillableTransmuxingMinutesbytesEncodeddatelabeltimeEncoded
\ No newline at end of file diff --git a/docs/classes/DailyStatisticsPerLabel.html b/docs/classes/DailyStatisticsPerLabel.html index 157690973..7926e8579 100644 --- a/docs/classes/DailyStatisticsPerLabel.html +++ b/docs/classes/DailyStatisticsPerLabel.html @@ -1,9 +1,9 @@ DailyStatisticsPerLabel | @bitmovin/api-sdk

Class DailyStatisticsPerLabel

Export

DailyStatisticsPerLabel

-

Constructors

constructor +

Constructors

constructor

Properties

date? labels? -

Constructors

constructor

Properties

Optional date

date?: Date

Date, format. yyyy-MM-dd (required)

+

Constructors

constructor

Properties

Optional date

date?: Date

Date, format. yyyy-MM-dd (required)

Memberof

DailyStatisticsPerLabel

-

Optional labels

labels?: DailyStatistics[]

List of labels and their aggregated statistics (required)

+

Optional labels

labels?: DailyStatistics[]

List of labels and their aggregated statistics (required)

Memberof

DailyStatisticsPerLabel

-

Settings

Member Visibility

Theme

On This Page

constructordatelabels
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordatelabels
\ No newline at end of file diff --git a/docs/classes/DashChunkedTextRepresentation.html b/docs/classes/DashChunkedTextRepresentation.html index 4786c31b5..971e35fd1 100644 --- a/docs/classes/DashChunkedTextRepresentation.html +++ b/docs/classes/DashChunkedTextRepresentation.html @@ -1,5 +1,5 @@ DashChunkedTextRepresentation | @bitmovin/api-sdk

Class DashChunkedTextRepresentation

Export

DashChunkedTextRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? encodingId? endKeyframeId? @@ -14,26 +14,26 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional endKeyframeId

endKeyframeId?: string

Id of the Keyframe to end with

+

Optional endKeyframeId

endKeyframeId?: string

Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.

Memberof

DashSegmentedRepresentation

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

Memberof

DashSegmentedRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

Memberof

DashSegmentedRepresentation

-

Optional startKeyframeId

startKeyframeId?: string

Id of the Keyframe to start with

+

Optional startKeyframeId

startKeyframeId?: string

Id of the keyframe to start with. It takes precedence over startSegmentNumber

Memberof

DashSegmentedRepresentation

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

Memberof

DashSegmentedRepresentation

-

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.CHUNKED_TEXT

Discriminator property for DashRepresentation

+

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.CHUNKED_TEXT

Discriminator property for DashRepresentation

Memberof

DashChunkedTextRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashCmafRepresentation.html b/docs/classes/DashCmafRepresentation.html index 10ce7e7d8..32d6befdf 100644 --- a/docs/classes/DashCmafRepresentation.html +++ b/docs/classes/DashCmafRepresentation.html @@ -1,5 +1,5 @@ DashCmafRepresentation | @bitmovin/api-sdk

Class DashCmafRepresentation

Export

DashCmafRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? encodingId? endKeyframeId? @@ -14,26 +14,26 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional endKeyframeId

endKeyframeId?: string

Id of the Keyframe to end with

+

Optional endKeyframeId

endKeyframeId?: string

Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.

Memberof

DashSegmentedRepresentation

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

Memberof

DashSegmentedRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

Memberof

DashSegmentedRepresentation

-

Optional startKeyframeId

startKeyframeId?: string

Id of the Keyframe to start with

+

Optional startKeyframeId

startKeyframeId?: string

Id of the keyframe to start with. It takes precedence over startSegmentNumber

Memberof

DashSegmentedRepresentation

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

Memberof

DashSegmentedRepresentation

-

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.CMAF

Discriminator property for DashRepresentation

+

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.CMAF

Discriminator property for DashRepresentation

Memberof

DashCmafRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashFmp4DrmRepresentation.html b/docs/classes/DashFmp4DrmRepresentation.html index 2006bfd00..5defdc542 100644 --- a/docs/classes/DashFmp4DrmRepresentation.html +++ b/docs/classes/DashFmp4DrmRepresentation.html @@ -1,5 +1,5 @@ DashFmp4DrmRepresentation | @bitmovin/api-sdk

Class DashFmp4DrmRepresentation

Export

DashFmp4DrmRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? drmId? encodingId? @@ -15,28 +15,28 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional drmId

drmId?: string

DRM Id (required)

+

Optional drmId

drmId?: string

DRM Id (required)

Memberof

DashFmp4DrmRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional endKeyframeId

endKeyframeId?: string

Id of the Keyframe to end with

+

Optional endKeyframeId

endKeyframeId?: string

Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.

Memberof

DashSegmentedRepresentation

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

Memberof

DashSegmentedRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

Memberof

DashSegmentedRepresentation

-

Optional startKeyframeId

startKeyframeId?: string

Id of the Keyframe to start with

+

Optional startKeyframeId

startKeyframeId?: string

Id of the keyframe to start with. It takes precedence over startSegmentNumber

Memberof

DashSegmentedRepresentation

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

Memberof

DashSegmentedRepresentation

-

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.DRM_FMP4

Discriminator property for DashRepresentation

+

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.DRM_FMP4

Discriminator property for DashRepresentation

Memberof

DashFmp4DrmRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIddrmIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIddrmIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashFmp4Representation.html b/docs/classes/DashFmp4Representation.html index 95921ec97..61af5d28c 100644 --- a/docs/classes/DashFmp4Representation.html +++ b/docs/classes/DashFmp4Representation.html @@ -1,5 +1,5 @@ DashFmp4Representation | @bitmovin/api-sdk

Class DashFmp4Representation

Export

DashFmp4Representation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? encodingId? endKeyframeId? @@ -14,26 +14,26 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional endKeyframeId

endKeyframeId?: string

Id of the Keyframe to end with

+

Optional endKeyframeId

endKeyframeId?: string

Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.

Memberof

DashSegmentedRepresentation

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

Memberof

DashSegmentedRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

Memberof

DashSegmentedRepresentation

-

Optional startKeyframeId

startKeyframeId?: string

Id of the Keyframe to start with

+

Optional startKeyframeId

startKeyframeId?: string

Id of the keyframe to start with. It takes precedence over startSegmentNumber

Memberof

DashSegmentedRepresentation

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

Memberof

DashSegmentedRepresentation

-

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.FMP4

Discriminator property for DashRepresentation

+

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.FMP4

Discriminator property for DashRepresentation

Memberof

DashFmp4Representation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashImscRepresentation.html b/docs/classes/DashImscRepresentation.html index 09324d91e..21c7e1a5f 100644 --- a/docs/classes/DashImscRepresentation.html +++ b/docs/classes/DashImscRepresentation.html @@ -1,14 +1,14 @@ DashImscRepresentation | @bitmovin/api-sdk

Class DashImscRepresentation

Export

DashImscRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? imscUrl? typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional imscUrl

imscUrl?: string

URL of the referenced IMSC file (required)

+

Optional imscUrl

imscUrl?: string

URL of the referenced IMSC file (required)

Memberof

DashImscRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.IMSC

Discriminator property for DashRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.IMSC

Discriminator property for DashRepresentation

Memberof

DashImscRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructoridimscUrltypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructoridimscUrltypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashManifest.html b/docs/classes/DashManifest.html index db9a4ba21..c0ab99e80 100644 --- a/docs/classes/DashManifest.html +++ b/docs/classes/DashManifest.html @@ -1,5 +1,5 @@ DashManifest | @bitmovin/api-sdk

Class DashManifest

Export

DashManifest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? dashEditionCompatibility? @@ -14,31 +14,31 @@ status? type? utcTimings? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional dashEditionCompatibility

dashEditionCompatibility?: V4

The manifest compatibility with the standard DASH Edition.

+

Optional dashEditionCompatibility

dashEditionCompatibility?: V4

The manifest compatibility with the standard DASH Edition.

Memberof

DashManifest

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional manifestName

manifestName?: string

The filename of your manifest

+

Optional manifestName

manifestName?: string

The filename of your manifest

Memberof

DashManifest

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional namespaces

namespaces?: XmlNamespace[]

List of additional XML namespaces to add to the DASH Manifest

+

Optional namespaces

namespaces?: XmlNamespace[]

List of additional XML namespaces to add to the DASH Manifest

Memberof

DashManifest

-

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

+

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

Memberof

Manifest

-

Optional profile

profile?: DashProfile

Determines if segmented or progressive representations can appear in the manifest

+

Optional profile

profile?: DashProfile

Determines if segmented or progressive representations can appear in the manifest

Memberof

DashManifest

-

Optional status

status?: Status

Current status

+

Optional status

status?: Status

Current status

Memberof

Manifest

-

Optional type

type?: ManifestType

Memberof

Manifest

-

Optional utcTimings

utcTimings?: UtcTiming[]

List of UTC Timings to use for live streaming

+

Optional type

type?: ManifestType

Memberof

Manifest

+

Optional utcTimings

utcTimings?: UtcTiming[]

List of UTC Timings to use for live streaming

Memberof

DashManifest

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadashEditionCompatibilitydescriptionidmanifestNamemodifiedAtnamenamespacesoutputsprofilestatustypeutcTimings
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadashEditionCompatibilitydescriptionidmanifestNamemodifiedAtnamenamespacesoutputsprofilestatustypeutcTimings
\ No newline at end of file diff --git a/docs/classes/DashManifestDefault.html b/docs/classes/DashManifestDefault.html index 6646e9247..050d35789 100644 --- a/docs/classes/DashManifestDefault.html +++ b/docs/classes/DashManifestDefault.html @@ -1,5 +1,5 @@ DashManifestDefault | @bitmovin/api-sdk

Class DashManifestDefault

Export

DashManifestDefault

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? dashEditionCompatibility? @@ -17,37 +17,37 @@ type? utcTimings? version? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional dashEditionCompatibility

dashEditionCompatibility?: V4

The manifest compatibility with the standard DASH Edition.

+

Optional dashEditionCompatibility

dashEditionCompatibility?: V4

The manifest compatibility with the standard DASH Edition.

Memberof

DashManifest

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional encodingId

encodingId?: string

The id of the encoding to create a default manifest for. Either "encodingId" or "periods" is required.

+

Optional encodingId

encodingId?: string

The id of the encoding to create a default manifest for. Either "encodingId" or "periods" is required.

Memberof

DashManifestDefault

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional manifestName

manifestName?: string

The filename of your manifest

+

Optional manifestName

manifestName?: string

The filename of your manifest

Memberof

DashManifest

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional namespaces

namespaces?: XmlNamespace[]

List of additional XML namespaces to add to the DASH Manifest

+

Optional namespaces

namespaces?: XmlNamespace[]

List of additional XML namespaces to add to the DASH Manifest

Memberof

DashManifest

-

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

+

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

Memberof

Manifest

-

Optional periods

periods?: DefaultDashManifestPeriod[]

Adds a period for every item. Can only be used when setting "version" to "V2". Either "periods" or "encodingId" is required.

+

Optional periods

periods?: DefaultDashManifestPeriod[]

Adds a period for every item. Can only be used when setting "version" to "V2". Either "periods" or "encodingId" is required.

Memberof

DashManifestDefault

-

Optional profile

profile?: DashProfile

Determines if segmented or progressive representations can appear in the manifest

+

Optional profile

profile?: DashProfile

Determines if segmented or progressive representations can appear in the manifest

Memberof

DashManifest

-

Optional status

status?: Status

Current status

+

Optional status

status?: Status

Current status

Memberof

Manifest

-

Optional type

type?: ManifestType

Memberof

Manifest

-

Optional utcTimings

utcTimings?: UtcTiming[]

List of UTC Timings to use for live streaming

+

Optional type

type?: ManifestType

Memberof

Manifest

+

Optional utcTimings

utcTimings?: UtcTiming[]

List of UTC Timings to use for live streaming

Memberof

DashManifest

-

Optional version

version?: DashManifestDefaultVersion

Specifies the algorithm that determines which output of the given encoding is included into the manifest. Note that this is not related to the "manifestGenerator" version of the "Start" request.

+

Optional version

version?: DashManifestDefaultVersion

Specifies the algorithm that determines which output of the given encoding is included into the manifest. Note that this is not related to the "manifestGenerator" version of the "Start" request.

Memberof

DashManifestDefault

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadashEditionCompatibilitydescriptionencodingIdidmanifestNamemodifiedAtnamenamespacesoutputsperiodsprofilestatustypeutcTimingsversion
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadashEditionCompatibilitydescriptionencodingIdidmanifestNamemodifiedAtnamenamespacesoutputsperiodsprofilestatustypeutcTimingsversion
\ No newline at end of file diff --git a/docs/classes/DashMp4DrmRepresentation.html b/docs/classes/DashMp4DrmRepresentation.html index 9095bbf20..464ed7236 100644 --- a/docs/classes/DashMp4DrmRepresentation.html +++ b/docs/classes/DashMp4DrmRepresentation.html @@ -1,5 +1,5 @@ DashMp4DrmRepresentation | @bitmovin/api-sdk

Class DashMp4DrmRepresentation

Export

DashMp4DrmRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? drmId? encodingId? @@ -10,20 +10,20 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional drmId

drmId?: string

DRM Id (required)

+

Optional drmId

drmId?: string

DRM Id (required)

Memberof

DashMp4DrmRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional filePath

filePath?: string

Path to the MP4 file (required)

+

Optional filePath

filePath?: string

Path to the MP4 file (required)

Memberof

DashMp4Representation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Optional type

type?: DashOnDemandRepresentationType

The type of the dash representation

+

Optional type

type?: DashOnDemandRepresentationType

The type of the dash representation

Memberof

DashMp4Representation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.DRM_MP4

Discriminator property for DashRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.DRM_MP4

Discriminator property for DashRepresentation

Memberof

DashMp4DrmRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIddrmIdencodingIdfilePathidmuxingIdtypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIddrmIdencodingIdfilePathidmuxingIdtypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashMp4Representation.html b/docs/classes/DashMp4Representation.html index 3cdf84a69..b3d5b0b0d 100644 --- a/docs/classes/DashMp4Representation.html +++ b/docs/classes/DashMp4Representation.html @@ -1,5 +1,5 @@ DashMp4Representation | @bitmovin/api-sdk

Class DashMp4Representation

Export

DashMp4Representation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? encodingId? filePath? @@ -9,18 +9,18 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional filePath

filePath?: string

Path to the MP4 file (required)

+

Optional filePath

filePath?: string

Path to the MP4 file (required)

Memberof

DashMp4Representation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Optional type

type?: DashOnDemandRepresentationType

The type of the dash representation

+

Optional type

type?: DashOnDemandRepresentationType

The type of the dash representation

Memberof

DashMp4Representation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.MP4

Discriminator property for DashRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.MP4

Discriminator property for DashRepresentation

Memberof

DashMp4Representation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdfilePathidmuxingIdtypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdfilePathidmuxingIdtypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashMuxingRepresentation.html b/docs/classes/DashMuxingRepresentation.html index d59b2fbf1..21c3cfa77 100644 --- a/docs/classes/DashMuxingRepresentation.html +++ b/docs/classes/DashMuxingRepresentation.html @@ -1,17 +1,17 @@ DashMuxingRepresentation | @bitmovin/api-sdk

Class DashMuxingRepresentation

Export

DashMuxingRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? encodingId? id? muxingId? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdidmuxingId_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdidmuxingId_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashProgressiveWebmRepresentation.html b/docs/classes/DashProgressiveWebmRepresentation.html index 33091c08c..587418a52 100644 --- a/docs/classes/DashProgressiveWebmRepresentation.html +++ b/docs/classes/DashProgressiveWebmRepresentation.html @@ -1,5 +1,5 @@ DashProgressiveWebmRepresentation | @bitmovin/api-sdk

Class DashProgressiveWebmRepresentation

Export

DashProgressiveWebmRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? encodingId? filePath? @@ -8,16 +8,16 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional filePath

filePath?: string

Path to the Progressive WebM file (required)

+

Optional filePath

filePath?: string

Path to the Progressive WebM file (required)

Memberof

DashProgressiveWebmRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.PROGRESSIVE_WEBM

Discriminator property for DashRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.PROGRESSIVE_WEBM

Discriminator property for DashRepresentation

Memberof

DashProgressiveWebmRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdfilePathidmuxingIdtypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdfilePathidmuxingIdtypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashRepresentation.html b/docs/classes/DashRepresentation.html index 5360660f0..a6739786b 100644 --- a/docs/classes/DashRepresentation.html +++ b/docs/classes/DashRepresentation.html @@ -1,8 +1,8 @@ DashRepresentation | @bitmovin/api-sdk

Class DashRepresentation

Export

DashRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructorid_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructorid_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashRepresentationTypeResponse.html b/docs/classes/DashRepresentationTypeResponse.html index 6cfdffbb9..c2eb1a629 100644 --- a/docs/classes/DashRepresentationTypeResponse.html +++ b/docs/classes/DashRepresentationTypeResponse.html @@ -1,6 +1,6 @@ DashRepresentationTypeResponse | @bitmovin/api-sdk

Class DashRepresentationTypeResponse

Export

DashRepresentationTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: DashRepresentationTypeDiscriminator

The type of the DASH representation

+

Constructors

constructor

Properties

Optional type

type?: DashRepresentationTypeDiscriminator

The type of the DASH representation

Memberof

DashRepresentationTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/DashSegmentedRepresentation.html b/docs/classes/DashSegmentedRepresentation.html index d707515f1..194b61fb1 100644 --- a/docs/classes/DashSegmentedRepresentation.html +++ b/docs/classes/DashSegmentedRepresentation.html @@ -1,5 +1,5 @@ DashSegmentedRepresentation | @bitmovin/api-sdk

Class DashSegmentedRepresentation

Export

DashSegmentedRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? encodingId? endKeyframeId? @@ -13,24 +13,24 @@ type? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional endKeyframeId

endKeyframeId?: string

Id of the Keyframe to end with

+

Optional endKeyframeId

endKeyframeId?: string

Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.

Memberof

DashSegmentedRepresentation

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

Memberof

DashSegmentedRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

Memberof

DashSegmentedRepresentation

-

Optional startKeyframeId

startKeyframeId?: string

Id of the Keyframe to start with

+

Optional startKeyframeId

startKeyframeId?: string

Id of the keyframe to start with. It takes precedence over startSegmentNumber

Memberof

DashSegmentedRepresentation

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

Memberof

DashSegmentedRepresentation

-

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashVttRepresentation.html b/docs/classes/DashVttRepresentation.html index e98fed8bc..7124163fe 100644 --- a/docs/classes/DashVttRepresentation.html +++ b/docs/classes/DashVttRepresentation.html @@ -1,14 +1,14 @@ DashVttRepresentation | @bitmovin/api-sdk

Class DashVttRepresentation

Export

DashVttRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? typeDiscriminator vttUrl? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.VTT

Discriminator property for DashRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.VTT

Discriminator property for DashRepresentation

Memberof

DashVttRepresentation

-

Optional vttUrl

vttUrl?: string

URL of the referenced VTT file (required)

+

Optional vttUrl

vttUrl?: string

URL of the referenced VTT file (required)

Memberof

DashVttRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructoridtypeDiscriminatorvttUrl_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructoridtypeDiscriminatorvttUrl_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DashWebmRepresentation.html b/docs/classes/DashWebmRepresentation.html index 87d823406..cc6e1f1d8 100644 --- a/docs/classes/DashWebmRepresentation.html +++ b/docs/classes/DashWebmRepresentation.html @@ -1,5 +1,5 @@ DashWebmRepresentation | @bitmovin/api-sdk

Class DashWebmRepresentation

Export

DashWebmRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

dependencyId? encodingId? endKeyframeId? @@ -14,26 +14,26 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

+

Constructors

constructor

Properties

Optional dependencyId

dependencyId?: string

Used to signal a dependency with another representation. The representation may belong to a different adaptation set

Memberof

DashMuxingRepresentation

-

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

DashMuxingRepresentation

-

Optional endKeyframeId

endKeyframeId?: string

Id of the Keyframe to end with

+

Optional endKeyframeId

endKeyframeId?: string

Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.

Memberof

DashSegmentedRepresentation

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded

Memberof

DashSegmentedRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

-

Optional muxingId

muxingId?: string

UUID of a muxing (required)

+

Optional mode

mode?: DashRepresentationTypeMode

Memberof

DashSegmentedRepresentation

+

Optional muxingId

muxingId?: string

UUID of a muxing (required)

Memberof

DashMuxingRepresentation

-

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)

Memberof

DashSegmentedRepresentation

-

Optional startKeyframeId

startKeyframeId?: string

Id of the Keyframe to start with

+

Optional startKeyframeId

startKeyframeId?: string

Id of the keyframe to start with. It takes precedence over startSegmentNumber

Memberof

DashSegmentedRepresentation

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment

Memberof

DashSegmentedRepresentation

-

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.WEBM

Discriminator property for DashRepresentation

+

Optional type

type?: DashRepresentationType

Memberof

DashSegmentedRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.WEBM

Discriminator property for DashRepresentation

Memberof

DashWebmRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructordependencyIdencodingIdendKeyframeIdendSegmentNumberidmodemuxingIdsegmentPathstartKeyframeIdstartSegmentNumbertypetypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DefaultDashManifestPeriod.html b/docs/classes/DefaultDashManifestPeriod.html index a62874929..a1df73d3c 100644 --- a/docs/classes/DefaultDashManifestPeriod.html +++ b/docs/classes/DefaultDashManifestPeriod.html @@ -1,9 +1,9 @@ DefaultDashManifestPeriod | @bitmovin/api-sdk

Class DefaultDashManifestPeriod

Export

DefaultDashManifestPeriod

-

Constructors

constructor +

Constructors

constructor

Properties

adaptationSets? encodingIds? -

Constructors

constructor

Properties

Optional adaptationSets

adaptationSets?: DefaultManifestCondition[]

Adds an adaption set for every item to the period

+

Constructors

constructor

Properties

Optional adaptationSets

adaptationSets?: DefaultManifestCondition[]

Adds an adaption set for every item to the period

Memberof

DefaultDashManifestPeriod

-

Optional encodingIds

encodingIds?: string[]

List the encoding ids for which the conditions should apply

+

Optional encodingIds

encodingIds?: string[]

List the encoding ids for which the conditions should apply

Memberof

DefaultDashManifestPeriod

-

Settings

Member Visibility

Theme

On This Page

constructoradaptationSetsencodingIds
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoradaptationSetsencodingIds
\ No newline at end of file diff --git a/docs/classes/DefaultManifestAndCondition.html b/docs/classes/DefaultManifestAndCondition.html index 940441e25..47d7ef069 100644 --- a/docs/classes/DefaultManifestAndCondition.html +++ b/docs/classes/DefaultManifestAndCondition.html @@ -1,11 +1,11 @@ DefaultManifestAndCondition | @bitmovin/api-sdk

Class DefaultManifestAndCondition

Export

DefaultManifestAndCondition

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

conditions? type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional conditions

conditions?: DefaultManifestCondition[]

Array to perform the AND evaluation on. This conditions evaluates to true if all sub conditions evaluate to true.

+

Constructors

constructor

Properties

Optional conditions

conditions?: DefaultManifestCondition[]

Array to perform the AND evaluation on. This conditions evaluates to true if all sub conditions evaluate to true.

Memberof

DefaultManifestAndCondition

-

Readonly type

type: ConditionType = ConditionType.AND

Discriminator property for DefaultManifestCondition

+

Readonly type

type: ConditionType = ConditionType.AND

Discriminator property for DefaultManifestCondition

Memberof

DefaultManifestAndCondition

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditionstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditionstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DefaultManifestAttributeCondition.html b/docs/classes/DefaultManifestAttributeCondition.html index 607a7a91d..d1f5c62f1 100644 --- a/docs/classes/DefaultManifestAttributeCondition.html +++ b/docs/classes/DefaultManifestAttributeCondition.html @@ -1,17 +1,17 @@ DefaultManifestAttributeCondition | @bitmovin/api-sdk

Class DefaultManifestAttributeCondition

Export

DefaultManifestAttributeCondition

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

attribute? operator? type value? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional attribute

attribute?: string

The attribute that should be used for the evaluation: - audio.codec - audio.language - audio.bitrate - subtitle.format - subtitle.language - video.height - video.width - video.codec - video.bitrate - drm.type - muxing.type (required)

+

Constructors

constructor

Properties

Optional attribute

attribute?: string

The attribute that should be used for the evaluation: - audio.codec - audio.language - audio.bitrate - subtitle.format - subtitle.language - video.height - video.width - video.codec - video.bitrate - drm.type - muxing.type (required)

Memberof

DefaultManifestAttributeCondition

-

Optional operator

operator?: ConditionOperator

The operator that should be used for the evaluation (required)

+

Optional operator

operator?: ConditionOperator

The operator that should be used for the evaluation (required)

Memberof

DefaultManifestAttributeCondition

-

Readonly type

type: ConditionType = ConditionType.CONDITION

Discriminator property for DefaultManifestCondition

+

Readonly type

type: ConditionType = ConditionType.CONDITION

Discriminator property for DefaultManifestCondition

Memberof

DefaultManifestAttributeCondition

-

Optional value

value?: string

The value that should be used for comparison. Valid values depend on the attribute: - audio.codec (Enum; e.g., AAC, MP3, OPUS) - audio.language (String) - audio.bitrate (Integer) - subtitle.format (Enum; e.g., WEBVTT) - subtitle.language (String) - video.height (Integer) - video.width (Integer) - video.codec (Enum; e.g., AV1, H264, VP9) - video.bitrate (Integer) - drm.type (Enum; NoDrm, Cenc, CencWidevine, CencPlayReady, CencMarlin, CencFairPlay, Aes128, ClearKey, PrimeTime, Widevine, PlayReady, Marlin, FairPlay) - muxing.type (Enum; e.g., FMP4, MP4) (required)

+

Optional value

value?: string

The value that should be used for comparison. Valid values depend on the attribute: - audio.codec (Enum; e.g., AAC, MP3, OPUS) - audio.language (String) - audio.bitrate (Integer) - subtitle.format (Enum; e.g., WEBVTT) - subtitle.language (String) - video.height (Integer) - video.width (Integer) - video.codec (Enum; e.g., AV1, H264, VP9) - video.bitrate (Integer) - drm.type (Enum; NoDrm, Cenc, CencWidevine, CencPlayReady, CencMarlin, CencFairPlay, Aes128, ClearKey, PrimeTime, Widevine, PlayReady, Marlin, FairPlay) - muxing.type (Enum; e.g., FMP4, MP4) (required)

Memberof

DefaultManifestAttributeCondition

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorattributeoperatortypevalue_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorattributeoperatortypevalue_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DefaultManifestCondition.html b/docs/classes/DefaultManifestCondition.html index 513152ad4..6dffc1973 100644 --- a/docs/classes/DefaultManifestCondition.html +++ b/docs/classes/DefaultManifestCondition.html @@ -1,5 +1,5 @@ DefaultManifestCondition | @bitmovin/api-sdk

Class DefaultManifestCondition

Export

DefaultManifestCondition

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

_discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructor_discriminatorMapping_discriminatorName
\ No newline at end of file +

Constructors

constructor

Properties

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructor_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DefaultManifestOrCondition.html b/docs/classes/DefaultManifestOrCondition.html index 153e9924d..d665fe100 100644 --- a/docs/classes/DefaultManifestOrCondition.html +++ b/docs/classes/DefaultManifestOrCondition.html @@ -1,11 +1,11 @@ DefaultManifestOrCondition | @bitmovin/api-sdk

Class DefaultManifestOrCondition

Export

DefaultManifestOrCondition

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

conditions? type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional conditions

conditions?: DefaultManifestCondition[]

Array to perform the OR evaluation on. This conditions evaluates to true if at least one sub condition evaluates to true.

+

Constructors

constructor

Properties

Optional conditions

conditions?: DefaultManifestCondition[]

Array to perform the OR evaluation on. This conditions evaluates to true if at least one sub condition evaluates to true.

Memberof

DefaultManifestOrCondition

-

Readonly type

type: ConditionType = ConditionType.OR

Discriminator property for DefaultManifestCondition

+

Readonly type

type: ConditionType = ConditionType.OR

Discriminator property for DefaultManifestCondition

Memberof

DefaultManifestOrCondition

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditionstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditionstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DeinterlaceFilter.html b/docs/classes/DeinterlaceFilter.html index b92a41932..4c56ab647 100644 --- a/docs/classes/DeinterlaceFilter.html +++ b/docs/classes/DeinterlaceFilter.html @@ -1,5 +1,5 @@ DeinterlaceFilter | @bitmovin/api-sdk

Class DeinterlaceFilter

Export

DeinterlaceFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoEnable? createdAt? customData? @@ -13,22 +13,22 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional autoEnable

autoEnable?: DeinterlaceAutoEnable

Memberof

DeinterlaceFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional autoEnable

autoEnable?: DeinterlaceAutoEnable

Memberof

DeinterlaceFilter

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional frameSelectionMode

frameSelectionMode?: DeinterlaceFrameSelectionMode

Memberof

DeinterlaceFilter

-

Optional id

id?: string

Id of the resource (required)

+

Optional frameSelectionMode

frameSelectionMode?: DeinterlaceFrameSelectionMode

Memberof

DeinterlaceFilter

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: DeinterlaceMode

Memberof

DeinterlaceFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional mode

mode?: DeinterlaceMode

Memberof

DeinterlaceFilter

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional parity

parity?: PictureFieldParity

Memberof

DeinterlaceFilter

-

Readonly type

type: FilterType = FilterType.DEINTERLACE

Discriminator property for Filter

+

Optional parity

parity?: PictureFieldParity

Memberof

DeinterlaceFilter

+

Readonly type

type: FilterType = FilterType.DEINTERLACE

Discriminator property for Filter

Memberof

DeinterlaceFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorautoEnablecreatedAtcustomDatadescriptionframeSelectionModeidmodemodifiedAtnameparitytype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorautoEnablecreatedAtcustomDatadescriptionframeSelectionModeidmodemodifiedAtnameparitytype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DenoiseHqdn3dFilter.html b/docs/classes/DenoiseHqdn3dFilter.html index c23828843..1a30cc395 100644 --- a/docs/classes/DenoiseHqdn3dFilter.html +++ b/docs/classes/DenoiseHqdn3dFilter.html @@ -1,5 +1,5 @@ DenoiseHqdn3dFilter | @bitmovin/api-sdk

Class DenoiseHqdn3dFilter

Export

DenoiseHqdn3dFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

chromaSpatial? chromaTmp? createdAt? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional chromaSpatial

chromaSpatial?: number

A non-negative floating point number which specifies spatial chroma strength. It defaults to 3.0*luma_spatial/4.0.

+

Constructors

constructor

Properties

Optional chromaSpatial

chromaSpatial?: number

A non-negative floating point number which specifies spatial chroma strength. It defaults to 3.0*luma_spatial/4.0.

Memberof

DenoiseHqdn3dFilter

-

Optional chromaTmp

chromaTmp?: number

A floating point number which specifies chroma temporal strength. It defaults to luma_tmp*chroma_spatial/luma_spatial.

+

Optional chromaTmp

chromaTmp?: number

A floating point number which specifies chroma temporal strength. It defaults to luma_tmp*chroma_spatial/luma_spatial.

Memberof

DenoiseHqdn3dFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional lumaSpatial

lumaSpatial?: number

A non-negative floating point number which specifies spatial luma strength. It defaults to 4.0.

+

Optional lumaSpatial

lumaSpatial?: number

A non-negative floating point number which specifies spatial luma strength. It defaults to 4.0.

Memberof

DenoiseHqdn3dFilter

-

Optional lumaTmp

lumaTmp?: number

A floating point number which specifies luma temporal strength. It defaults to 6.0*luma_spatial/4.0.

+

Optional lumaTmp

lumaTmp?: number

A floating point number which specifies luma temporal strength. It defaults to 6.0*luma_spatial/4.0.

Memberof

DenoiseHqdn3dFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: FilterType = FilterType.DENOISE_HQDN3D

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.DENOISE_HQDN3D

Discriminator property for Filter

Memberof

DenoiseHqdn3dFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorchromaSpatialchromaTmpcreatedAtcustomDatadescriptionidlumaSpatiallumaTmpmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorchromaSpatialchromaTmpcreatedAtcustomDatadescriptionidlumaSpatiallumaTmpmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DirectFileUploadInput.html b/docs/classes/DirectFileUploadInput.html index 5fb97f7cf..a1c6de9e8 100644 --- a/docs/classes/DirectFileUploadInput.html +++ b/docs/classes/DirectFileUploadInput.html @@ -1,5 +1,5 @@ DirectFileUploadInput | @bitmovin/api-sdk

Class DirectFileUploadInput

Export

DirectFileUploadInput

-

Hierarchy (view full)

  • Input
    • DirectFileUploadInput

Constructors

constructor +

Hierarchy (view full)

  • Input
    • DirectFileUploadInput

Constructors

constructor

Properties

createdAt? customData? description? @@ -10,20 +10,20 @@ uploadUrl? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputType = InputType.DIRECT_FILE_UPLOAD

Discriminator property for Input

+

Readonly type

type: InputType = InputType.DIRECT_FILE_UPLOAD

Discriminator property for Input

Memberof

DirectFileUploadInput

-

Optional uploadUrl

uploadUrl?: string

The URL to be used for a file upload with HTTP PUT. Expires after 5 minutes.

+

Optional uploadUrl

uploadUrl?: string

The URL to be used for a file upload with HTTP PUT. Expires after 5 minutes.

Memberof

DirectFileUploadInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametypeuploadUrl_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametypeuploadUrl_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DisplayAspectRatio.html b/docs/classes/DisplayAspectRatio.html index 62b29fa32..ecb230188 100644 --- a/docs/classes/DisplayAspectRatio.html +++ b/docs/classes/DisplayAspectRatio.html @@ -1,9 +1,9 @@ DisplayAspectRatio | @bitmovin/api-sdk

Class DisplayAspectRatio

Export

DisplayAspectRatio

-

Constructors

constructor +

Constructors

constructor

Properties

denominator? numerator? -

Constructors

constructor

Properties

Optional denominator

denominator?: number

The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used. (required)

+

Constructors

constructor

Properties

Optional denominator

denominator?: number

The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used. (required)

Memberof

DisplayAspectRatio

-

Optional numerator

numerator?: number

The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used. (required)

+

Optional numerator

numerator?: number

The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used. (required)

Memberof

DisplayAspectRatio

-

Settings

Member Visibility

Theme

On This Page

constructordenominatornumerator
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordenominatornumerator
\ No newline at end of file diff --git a/docs/classes/DolbyAtmosAudioConfiguration.html b/docs/classes/DolbyAtmosAudioConfiguration.html index 25f9f3f9d..41b507886 100644 --- a/docs/classes/DolbyAtmosAudioConfiguration.html +++ b/docs/classes/DolbyAtmosAudioConfiguration.html @@ -1,5 +1,5 @@ DolbyAtmosAudioConfiguration | @bitmovin/api-sdk

Class DolbyAtmosAudioConfiguration

Export

DolbyAtmosAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? createdAt? customData? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional loudnessControl

loudnessControl?: DolbyAtmosLoudnessControl

Settings for loudness control (required)

+

Optional loudnessControl

loudnessControl?: DolbyAtmosLoudnessControl

Settings for loudness control (required)

Memberof

DolbyAtmosAudioConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.DOLBY_ATMOS

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.DOLBY_ATMOS

Discriminator property for CodecConfiguration

Memberof

DolbyAtmosAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecreatedAtcustomDatadescriptionidloudnessControlmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecreatedAtcustomDatadescriptionidloudnessControlmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DolbyAtmosIngestInputStream.html b/docs/classes/DolbyAtmosIngestInputStream.html index c7f2fdcd7..69bd1d722 100644 --- a/docs/classes/DolbyAtmosIngestInputStream.html +++ b/docs/classes/DolbyAtmosIngestInputStream.html @@ -1,5 +1,5 @@ DolbyAtmosIngestInputStream | @bitmovin/api-sdk

Class DolbyAtmosIngestInputStream

Export

DolbyAtmosIngestInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputFormat

inputFormat?: DolbyAtmosInputFormat

Input file format of the Dolby Atmos input file. Set it to DAMF if the given input file is a Dolby Atmos Master File (.atmos). Set it to ADM if the given input file is an Audio Definition Model Broadcast Wave Format file (.wav) (required)

+

Optional inputFormat

inputFormat?: DolbyAtmosInputFormat

Input file format of the Dolby Atmos input file. Set it to DAMF if the given input file is a Dolby Atmos Master File (.atmos). Set it to ADM if the given input file is an Audio Definition Model Broadcast Wave Format file (.wav) (required)

Memberof

DolbyAtmosIngestInputStream

-

Optional inputId

inputId?: string

Id of input (required)

+

Optional inputId

inputId?: string

Id of input (required)

Memberof

DolbyAtmosIngestInputStream

-

Optional inputPath

inputPath?: string

Path to the Dolby Atmos input file (required)

+

Optional inputPath

inputPath?: string

Path to the Dolby Atmos input file (required)

Memberof

DolbyAtmosIngestInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputStreamType = InputStreamType.DOLBY_ATMOS

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.DOLBY_ATMOS

Discriminator property for InputStream

Memberof

DolbyAtmosIngestInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputFormatinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputFormatinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DolbyAtmosLoudnessControl.html b/docs/classes/DolbyAtmosLoudnessControl.html index 8bb6101dc..7537af4b6 100644 --- a/docs/classes/DolbyAtmosLoudnessControl.html +++ b/docs/classes/DolbyAtmosLoudnessControl.html @@ -1,12 +1,12 @@ DolbyAtmosLoudnessControl | @bitmovin/api-sdk

Class DolbyAtmosLoudnessControl

Export

DolbyAtmosLoudnessControl

-

Constructors

constructor +

Constructors

constructor

Properties

dialogueIntelligence? meteringMode? speechThreshold? -

Constructors

constructor

Properties

Optional dialogueIntelligence

dialogueIntelligence?: DolbyAtmosDialogueIntelligence

Whether to use the Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating. Must not be "DISABLED" for meteringMode "ITU-R BS.1770-1" or "Leq (A)", otherwise recommended value is "ENABLED" (required)

+

Constructors

constructor

Properties

Optional dialogueIntelligence

dialogueIntelligence?: DolbyAtmosDialogueIntelligence

Whether to use the Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating. Must not be "DISABLED" for meteringMode "ITU-R BS.1770-1" or "Leq (A)", otherwise recommended value is "ENABLED" (required)

Memberof

DolbyAtmosLoudnessControl

-

Optional meteringMode

meteringMode?: DolbyAtmosMeteringMode

Algorithm to be used for measuring loudness. Recommended value is "ITU_R_BS_1770_4" (required)

+

Optional meteringMode

meteringMode?: DolbyAtmosMeteringMode

Algorithm to be used for measuring loudness. Recommended value is "ITU_R_BS_1770_4" (required)

Memberof

DolbyAtmosLoudnessControl

-

Optional speechThreshold

speechThreshold?: number

Specifies the percentage of speech that must be detected in the metered content before using the measured speech loudness as the overall program loudness. Given as an integer percentage between 0 and 100 (0% to 100%). Recommended value is 15 (required)

+

Optional speechThreshold

speechThreshold?: number

Specifies the percentage of speech that must be detected in the metered content before using the measured speech loudness as the overall program loudness. Given as an integer percentage between 0 and 100 (0% to 100%). Recommended value is 15 (required)

Memberof

DolbyAtmosLoudnessControl

-

Settings

Member Visibility

Theme

On This Page

constructordialogueIntelligencemeteringModespeechThreshold
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordialogueIntelligencemeteringModespeechThreshold
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalAudioConfiguration.html b/docs/classes/DolbyDigitalAudioConfiguration.html index bb15807f0..f49c255ad 100644 --- a/docs/classes/DolbyDigitalAudioConfiguration.html +++ b/docs/classes/DolbyDigitalAudioConfiguration.html @@ -1,5 +1,5 @@ DolbyDigitalAudioConfiguration | @bitmovin/api-sdk

Class DolbyDigitalAudioConfiguration

Export

DolbyDigitalAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? bitstreamInfo? channelLayout? @@ -17,32 +17,32 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional bitstreamInfo

bitstreamInfo?: DolbyDigitalBitstreamInfo

BitstreamInfo defines metadata parameters contained in the Dolby Digital audio bitstream

+

Optional bitstreamInfo

bitstreamInfo?: DolbyDigitalBitstreamInfo

BitstreamInfo defines metadata parameters contained in the Dolby Digital audio bitstream

Memberof

DolbyDigitalAudioConfiguration

-

Optional channelLayout

channelLayout?: DolbyDigitalChannelLayout

Channel layout of the audio codec configuration.

+

Optional channelLayout

channelLayout?: DolbyDigitalChannelLayout

Channel layout of the audio codec configuration.

Memberof

DolbyDigitalAudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional downmixing

downmixing?: DolbyDigitalDownmixing

Memberof

DolbyDigitalAudioConfiguration

-

Optional evolutionFrameworkControl

evolutionFrameworkControl?: DolbyDigitalEvolutionFrameworkControl

It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.

+

Optional downmixing

downmixing?: DolbyDigitalDownmixing

Memberof

DolbyDigitalAudioConfiguration

+

Optional evolutionFrameworkControl

evolutionFrameworkControl?: DolbyDigitalEvolutionFrameworkControl

It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.

Memberof

DolbyDigitalAudioConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional loudnessControl

loudnessControl?: DolbyDigitalLoudnessControl

Settings for loudness control (required)

+

Optional loudnessControl

loudnessControl?: DolbyDigitalLoudnessControl

Settings for loudness control (required)

Memberof

DolbyDigitalAudioConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional preprocessing

preprocessing?: DolbyDigitalPreprocessing

Memberof

DolbyDigitalAudioConfiguration

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional preprocessing

preprocessing?: DolbyDigitalPreprocessing

Memberof

DolbyDigitalAudioConfiguration

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.DD

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.DD

Discriminator property for CodecConfiguration

Memberof

DolbyDigitalAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratebitstreamInfochannelLayoutcreatedAtcustomDatadescriptiondownmixingevolutionFrameworkControlidloudnessControlmodifiedAtnamepreprocessingratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratebitstreamInfochannelLayoutcreatedAtcustomDatadescriptiondownmixingevolutionFrameworkControlidloudnessControlmodifiedAtnamepreprocessingratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalBitstreamInfo.html b/docs/classes/DolbyDigitalBitstreamInfo.html index d9f610f9d..14e1c6163 100644 --- a/docs/classes/DolbyDigitalBitstreamInfo.html +++ b/docs/classes/DolbyDigitalBitstreamInfo.html @@ -1,9 +1,9 @@ DolbyDigitalBitstreamInfo | @bitmovin/api-sdk

Class DolbyDigitalBitstreamInfo

Export

DolbyDigitalBitstreamInfo

-

Constructors

constructor +

Constructors

constructor

Properties

surroundExMode? surroundMode? -

Constructors

constructor

Properties

Optional surroundExMode

surroundExMode?: DolbyDigitalSurroundMode

This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX. This parameter is used only if the encoded audio has two surround channels. An amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically. The behavior is similar to that of the surroundMode parameter.

+

Constructors

constructor

Properties

Optional surroundExMode

surroundExMode?: DolbyDigitalSurroundMode

This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX. This parameter is used only if the encoded audio has two surround channels. An amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically. The behavior is similar to that of the surroundMode parameter.

Memberof

DolbyDigitalBitstreamInfo

-

Optional surroundMode

surroundMode?: DolbyDigitalSurroundMode

This parameter indicates to a decoder whether the two‐channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding. When downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: ENABLED, Lo/Ro: DISABLED). When transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream. When transcoding a third-party stereo input to stereo Dolby Digital set the value to NOT_INDICATED.

+

Optional surroundMode

surroundMode?: DolbyDigitalSurroundMode

This parameter indicates to a decoder whether the two‐channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding. When downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: ENABLED, Lo/Ro: DISABLED). When transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream. When transcoding a third-party stereo input to stereo Dolby Digital set the value to NOT_INDICATED.

Memberof

DolbyDigitalBitstreamInfo

-

Settings

Member Visibility

Theme

On This Page

constructorsurroundExModesurroundMode
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorsurroundExModesurroundMode
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalDownmixing.html b/docs/classes/DolbyDigitalDownmixing.html index 0bdd2dbf2..9c3418df0 100644 --- a/docs/classes/DolbyDigitalDownmixing.html +++ b/docs/classes/DolbyDigitalDownmixing.html @@ -1,18 +1,18 @@ DolbyDigitalDownmixing | @bitmovin/api-sdk

Class DolbyDigitalDownmixing

Downmixing is used to reproduce the complete audio program when the actual decoder outputs do not match the encoded channel layout of the original audio signal. The process of downmixing takes the information in the channels that do not have corresponding outputs, and mixes this information into the remaining channels.

Export

DolbyDigitalDownmixing

-

Constructors

constructor +

Constructors

constructor

Properties

loRoCenterMixLevel? loRoSurroundMixLevel? ltRtCenterMixLevel? ltRtSurroundMixLevel? preferredMode? -

Constructors

constructor

Properties

Optional loRoCenterMixLevel

loRoCenterMixLevel?: DolbyDigitalCenterMixLevel

The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.

+

Constructors

constructor

Properties

Optional loRoCenterMixLevel

loRoCenterMixLevel?: DolbyDigitalCenterMixLevel

The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.

Memberof

DolbyDigitalDownmixing

-

Optional loRoSurroundMixLevel

loRoSurroundMixLevel?: DolbyDigitalSurroundMixLevel

The level shift applied to the surround channels when downmixing to one Lo/Ro output.

+

Optional loRoSurroundMixLevel

loRoSurroundMixLevel?: DolbyDigitalSurroundMixLevel

The level shift applied to the surround channels when downmixing to one Lo/Ro output.

Memberof

DolbyDigitalDownmixing

-

Optional ltRtCenterMixLevel

ltRtCenterMixLevel?: DolbyDigitalCenterMixLevel

The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.

+

Optional ltRtCenterMixLevel

ltRtCenterMixLevel?: DolbyDigitalCenterMixLevel

The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.

Memberof

DolbyDigitalDownmixing

-

Optional ltRtSurroundMixLevel

ltRtSurroundMixLevel?: DolbyDigitalSurroundMixLevel

The level shift applied to the surround channels when downmixing to one Lt/Rt output.

+

Optional ltRtSurroundMixLevel

ltRtSurroundMixLevel?: DolbyDigitalSurroundMixLevel

The level shift applied to the surround channels when downmixing to one Lt/Rt output.

Memberof

DolbyDigitalDownmixing

-

Optional preferredMode

preferredMode?: DolbyDigitalDownmixingPreferredMode

Memberof

DolbyDigitalDownmixing

-

Settings

Member Visibility

Theme

On This Page

constructorloRoCenterMixLevelloRoSurroundMixLevelltRtCenterMixLevelltRtSurroundMixLevelpreferredMode
\ No newline at end of file +

Optional preferredMode

preferredMode?: DolbyDigitalDownmixingPreferredMode

Memberof

DolbyDigitalDownmixing

+

Settings

Member Visibility

Theme

On This Page

constructorloRoCenterMixLevelloRoSurroundMixLevelltRtCenterMixLevelltRtSurroundMixLevelpreferredMode
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalDynamicRangeCompression.html b/docs/classes/DolbyDigitalDynamicRangeCompression.html index 4ca762efd..427009ce3 100644 --- a/docs/classes/DolbyDigitalDynamicRangeCompression.html +++ b/docs/classes/DolbyDigitalDynamicRangeCompression.html @@ -1,9 +1,9 @@ DolbyDigitalDynamicRangeCompression | @bitmovin/api-sdk

Class DolbyDigitalDynamicRangeCompression

Export

DolbyDigitalDynamicRangeCompression

-

Constructors

constructor +

Constructors

constructor

Properties

lineMode? rfMode? -

Constructors

constructor

Properties

Optional lineMode

lineMode?: DolbyDigitalDynamicRangeCompressionMode

Line mode is intended for use in products providing line‐level or speaker‐level outputs, and is applicable to the widest range of products. Products such as set‐top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.

+

Constructors

constructor

Properties

Optional lineMode

lineMode?: DolbyDigitalDynamicRangeCompressionMode

Line mode is intended for use in products providing line‐level or speaker‐level outputs, and is applicable to the widest range of products. Products such as set‐top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.

Memberof

DolbyDigitalDynamicRangeCompression

-

Optional rfMode

rfMode?: DolbyDigitalDynamicRangeCompressionMode

RF mode is intended for products such as a low‐cost television receivers.

+

Optional rfMode

rfMode?: DolbyDigitalDynamicRangeCompressionMode

RF mode is intended for products such as a low‐cost television receivers.

Memberof

DolbyDigitalDynamicRangeCompression

-

Settings

Member Visibility

Theme

On This Page

constructorlineModerfMode
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorlineModerfMode
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalLoudnessControl.html b/docs/classes/DolbyDigitalLoudnessControl.html index df6bccd92..07e7bdbc5 100644 --- a/docs/classes/DolbyDigitalLoudnessControl.html +++ b/docs/classes/DolbyDigitalLoudnessControl.html @@ -1,17 +1,17 @@ DolbyDigitalLoudnessControl | @bitmovin/api-sdk

Class DolbyDigitalLoudnessControl

Export

DolbyDigitalLoudnessControl

-

Constructors

constructor +

Constructors

constructor

Properties

dialnorm? dialogueIntelligence? mode? peakLimit? regulationType? -

Constructors

constructor

Properties

Optional dialnorm

dialnorm?: number

Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialnorm must not be set.

+

Constructors

constructor

Properties

Optional dialnorm

dialnorm?: number

Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialnorm must not be set.

Memberof

DolbyDigitalLoudnessControl

-

Optional dialogueIntelligence

dialogueIntelligence?: DolbyDigitalDialogueIntelligence

This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialogueIntelligence must not be set.

+

Optional dialogueIntelligence

dialogueIntelligence?: DolbyDigitalDialogueIntelligence

This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialogueIntelligence must not be set.

Memberof

DolbyDigitalLoudnessControl

-

Optional mode

mode?: DolbyDigitalLoudnessControlMode

Memberof

DolbyDigitalLoudnessControl

-

Optional peakLimit

peakLimit?: number

The peak value in dB to use for loudness correction. This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations peakLimit must not be set.

+

Optional mode

mode?: DolbyDigitalLoudnessControlMode

Memberof

DolbyDigitalLoudnessControl

+

Optional peakLimit

peakLimit?: number

The peak value in dB to use for loudness correction. This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations peakLimit must not be set.

Memberof

DolbyDigitalLoudnessControl

-

Optional regulationType

regulationType?: DolbyDigitalLoudnessControlRegulationType

This is only allowed if the mode is CORRECTION. <th colspan=4 align="left"> Predefined values for each regulation type:
Regulation Type EBU R128 ATSC A/85 Fixed ATSC A/85 Agile
Limit Mode True Peak True Peak True Peak
Correction Mode PCM Normalization PCM Normalization Metadata Update
Peak Limit –3 dBTP –2 dBTP N/A
Dialogue Intelligence Off On On
Meter Mode ITU-R BS.1770-3 ITU-R BS.1770-3 ITU-R BS.1770-3
Speech Threshold 20 20 20
Dialogue Normalization -23 dB -24 dB Set to measured loudness

+

Optional regulationType

regulationType?: DolbyDigitalLoudnessControlRegulationType

This is only allowed if the mode is CORRECTION. <th colspan=4 align="left"> Predefined values for each regulation type:
Regulation Type EBU R128 ATSC A/85 Fixed ATSC A/85 Agile
Limit Mode True Peak True Peak True Peak
Correction Mode PCM Normalization PCM Normalization Metadata Update
Peak Limit –3 dBTP –2 dBTP N/A
Dialogue Intelligence Off On On
Meter Mode ITU-R BS.1770-3 ITU-R BS.1770-3 ITU-R BS.1770-3
Speech Threshold 20 20 20
Dialogue Normalization -23 dB -24 dB Set to measured loudness

Memberof

DolbyDigitalLoudnessControl

-

Settings

Member Visibility

Theme

On This Page

constructordialnormdialogueIntelligencemodepeakLimitregulationType
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordialnormdialogueIntelligencemodepeakLimitregulationType
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalPlusAudioConfiguration.html b/docs/classes/DolbyDigitalPlusAudioConfiguration.html index 5352dfaa0..237566ebd 100644 --- a/docs/classes/DolbyDigitalPlusAudioConfiguration.html +++ b/docs/classes/DolbyDigitalPlusAudioConfiguration.html @@ -1,5 +1,5 @@ DolbyDigitalPlusAudioConfiguration | @bitmovin/api-sdk

Class DolbyDigitalPlusAudioConfiguration

Export

DolbyDigitalPlusAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? bitstreamInfo? channelLayout? @@ -17,32 +17,32 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional bitstreamInfo

bitstreamInfo?: DolbyDigitalPlusBitstreamInfo

BitstreamInfo defines metadata parameters contained in the Dolby Digital Plus audio bitstream

+

Optional bitstreamInfo

bitstreamInfo?: DolbyDigitalPlusBitstreamInfo

BitstreamInfo defines metadata parameters contained in the Dolby Digital Plus audio bitstream

Memberof

DolbyDigitalPlusAudioConfiguration

-

Optional channelLayout

channelLayout?: DolbyDigitalPlusChannelLayout

Channel layout of the audio codec configuration.

+

Optional channelLayout

channelLayout?: DolbyDigitalPlusChannelLayout

Channel layout of the audio codec configuration.

Memberof

DolbyDigitalPlusAudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional downmixing

downmixing?: DolbyDigitalPlusDownmixing

Memberof

DolbyDigitalPlusAudioConfiguration

-

Optional evolutionFrameworkControl

evolutionFrameworkControl?: DolbyDigitalPlusEvolutionFrameworkControl

It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.

+

Optional downmixing

downmixing?: DolbyDigitalPlusDownmixing

Memberof

DolbyDigitalPlusAudioConfiguration

+

Optional evolutionFrameworkControl

evolutionFrameworkControl?: DolbyDigitalPlusEvolutionFrameworkControl

It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.

Memberof

DolbyDigitalPlusAudioConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional loudnessControl

loudnessControl?: DolbyDigitalPlusLoudnessControl

Settings for loudness control (required)

+

Optional loudnessControl

loudnessControl?: DolbyDigitalPlusLoudnessControl

Settings for loudness control (required)

Memberof

DolbyDigitalPlusAudioConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional preprocessing

preprocessing?: DolbyDigitalPlusPreprocessing

Memberof

DolbyDigitalPlusAudioConfiguration

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional preprocessing

preprocessing?: DolbyDigitalPlusPreprocessing

Memberof

DolbyDigitalPlusAudioConfiguration

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.DDPLUS

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.DDPLUS

Discriminator property for CodecConfiguration

Memberof

DolbyDigitalPlusAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratebitstreamInfochannelLayoutcreatedAtcustomDatadescriptiondownmixingevolutionFrameworkControlidloudnessControlmodifiedAtnamepreprocessingratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratebitstreamInfochannelLayoutcreatedAtcustomDatadescriptiondownmixingevolutionFrameworkControlidloudnessControlmodifiedAtnamepreprocessingratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalPlusBitstreamInfo.html b/docs/classes/DolbyDigitalPlusBitstreamInfo.html index ed8a6af8a..43a34b46b 100644 --- a/docs/classes/DolbyDigitalPlusBitstreamInfo.html +++ b/docs/classes/DolbyDigitalPlusBitstreamInfo.html @@ -1,9 +1,9 @@ DolbyDigitalPlusBitstreamInfo | @bitmovin/api-sdk

Class DolbyDigitalPlusBitstreamInfo

Export

DolbyDigitalPlusBitstreamInfo

-

Constructors

constructor +

Constructors

constructor

Properties

surroundExMode? surroundMode? -

Constructors

constructor

Properties

Optional surroundExMode

surroundExMode?: DolbyDigitalPlusSurroundMode

This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX. This parameter is used only if the encoded audio has two surround channels. An amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically. The behavior is similar to that of the surroundMode parameter.

+

Constructors

constructor

Properties

Optional surroundExMode

surroundExMode?: DolbyDigitalPlusSurroundMode

This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX. This parameter is used only if the encoded audio has two surround channels. An amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically. The behavior is similar to that of the surroundMode parameter.

Memberof

DolbyDigitalPlusBitstreamInfo

-

Optional surroundMode

surroundMode?: DolbyDigitalPlusSurroundMode

This parameter indicates to a decoder whether the two‐channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding. When downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: ENABLED, Lo/Ro: DISABLED). When transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream. When transcoding a third-party stereo input to stereo Dolby Digital set the value to NOT_INDICATED.

+

Optional surroundMode

surroundMode?: DolbyDigitalPlusSurroundMode

This parameter indicates to a decoder whether the two‐channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding. When downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: ENABLED, Lo/Ro: DISABLED). When transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream. When transcoding a third-party stereo input to stereo Dolby Digital set the value to NOT_INDICATED.

Memberof

DolbyDigitalPlusBitstreamInfo

-

Settings

Member Visibility

Theme

On This Page

constructorsurroundExModesurroundMode
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorsurroundExModesurroundMode
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalPlusDownmixing.html b/docs/classes/DolbyDigitalPlusDownmixing.html index 2c34d8d46..d36c7fb5c 100644 --- a/docs/classes/DolbyDigitalPlusDownmixing.html +++ b/docs/classes/DolbyDigitalPlusDownmixing.html @@ -1,18 +1,18 @@ DolbyDigitalPlusDownmixing | @bitmovin/api-sdk

Class DolbyDigitalPlusDownmixing

Downmixing is used to reproduce the complete audio program when the actual decoder outputs do not match the encoded channel layout of the original audio signal. The process of downmixing takes the information in the channels that do not have corresponding outputs, and mixes this information into the remaining channels.

Export

DolbyDigitalPlusDownmixing

-

Constructors

constructor +

Constructors

constructor

Properties

loRoCenterMixLevel? loRoSurroundMixLevel? ltRtCenterMixLevel? ltRtSurroundMixLevel? preferredMode? -

Constructors

constructor

Properties

Optional loRoCenterMixLevel

loRoCenterMixLevel?: DolbyDigitalPlusCenterMixLevel

The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.

+

Constructors

constructor

Properties

Optional loRoCenterMixLevel

loRoCenterMixLevel?: DolbyDigitalPlusCenterMixLevel

The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.

Memberof

DolbyDigitalPlusDownmixing

-

Optional loRoSurroundMixLevel

loRoSurroundMixLevel?: DolbyDigitalPlusSurroundMixLevel

The level shift applied to the surround channels when downmixing to one Lo/Ro output.

+

Optional loRoSurroundMixLevel

loRoSurroundMixLevel?: DolbyDigitalPlusSurroundMixLevel

The level shift applied to the surround channels when downmixing to one Lo/Ro output.

Memberof

DolbyDigitalPlusDownmixing

-

Optional ltRtCenterMixLevel

ltRtCenterMixLevel?: DolbyDigitalPlusCenterMixLevel

The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.

+

Optional ltRtCenterMixLevel

ltRtCenterMixLevel?: DolbyDigitalPlusCenterMixLevel

The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.

Memberof

DolbyDigitalPlusDownmixing

-

Optional ltRtSurroundMixLevel

ltRtSurroundMixLevel?: DolbyDigitalPlusSurroundMixLevel

The level shift applied to the surround channels when downmixing to one Lt/Rt output.

+

Optional ltRtSurroundMixLevel

ltRtSurroundMixLevel?: DolbyDigitalPlusSurroundMixLevel

The level shift applied to the surround channels when downmixing to one Lt/Rt output.

Memberof

DolbyDigitalPlusDownmixing

-

Optional preferredMode

preferredMode?: DolbyDigitalPlusDownmixingPreferredMode

Memberof

DolbyDigitalPlusDownmixing

-

Settings

Member Visibility

Theme

On This Page

constructorloRoCenterMixLevelloRoSurroundMixLevelltRtCenterMixLevelltRtSurroundMixLevelpreferredMode
\ No newline at end of file +

Optional preferredMode

preferredMode?: DolbyDigitalPlusDownmixingPreferredMode

Memberof

DolbyDigitalPlusDownmixing

+

Settings

Member Visibility

Theme

On This Page

constructorloRoCenterMixLevelloRoSurroundMixLevelltRtCenterMixLevelltRtSurroundMixLevelpreferredMode
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalPlusDynamicRangeCompression.html b/docs/classes/DolbyDigitalPlusDynamicRangeCompression.html index 15bab0c9e..9da9ddcad 100644 --- a/docs/classes/DolbyDigitalPlusDynamicRangeCompression.html +++ b/docs/classes/DolbyDigitalPlusDynamicRangeCompression.html @@ -1,9 +1,9 @@ DolbyDigitalPlusDynamicRangeCompression | @bitmovin/api-sdk

Class DolbyDigitalPlusDynamicRangeCompression

Export

DolbyDigitalPlusDynamicRangeCompression

-

Constructors

constructor +

Constructors

constructor

Properties

lineMode? rfMode? -

Constructors

constructor

Properties

Optional lineMode

lineMode?: DolbyDigitalPlusDynamicRangeCompressionMode

Line mode is intended for use in products providing line‐level or speaker‐level outputs, and is applicable to the widest range of products. Products such as set‐top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.

+

Constructors

constructor

Properties

Optional lineMode

lineMode?: DolbyDigitalPlusDynamicRangeCompressionMode

Line mode is intended for use in products providing line‐level or speaker‐level outputs, and is applicable to the widest range of products. Products such as set‐top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.

Memberof

DolbyDigitalPlusDynamicRangeCompression

-

Optional rfMode

rfMode?: DolbyDigitalPlusDynamicRangeCompressionMode

RF mode is intended for products such as a low‐cost television receiver.

+

Optional rfMode

rfMode?: DolbyDigitalPlusDynamicRangeCompressionMode

RF mode is intended for products such as a low‐cost television receiver.

Memberof

DolbyDigitalPlusDynamicRangeCompression

-

Settings

Member Visibility

Theme

On This Page

constructorlineModerfMode
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorlineModerfMode
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalPlusLoudnessControl.html b/docs/classes/DolbyDigitalPlusLoudnessControl.html index 66fed2e08..941446375 100644 --- a/docs/classes/DolbyDigitalPlusLoudnessControl.html +++ b/docs/classes/DolbyDigitalPlusLoudnessControl.html @@ -1,17 +1,17 @@ DolbyDigitalPlusLoudnessControl | @bitmovin/api-sdk

Class DolbyDigitalPlusLoudnessControl

Export

DolbyDigitalPlusLoudnessControl

-

Constructors

constructor +

Constructors

constructor

Properties

dialnorm? dialogueIntelligence? mode? peakLimit? regulationType? -

Constructors

constructor

Properties

Optional dialnorm

dialnorm?: number

Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialnorm must not be set.

+

Constructors

constructor

Properties

Optional dialnorm

dialnorm?: number

Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialnorm must not be set.

Memberof

DolbyDigitalPlusLoudnessControl

-

Optional dialogueIntelligence

dialogueIntelligence?: DolbyDigitalPlusDialogueIntelligence

This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other regulationType values dialogueIntelligence must not be set.

+

Optional dialogueIntelligence

dialogueIntelligence?: DolbyDigitalPlusDialogueIntelligence

This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other regulationType values dialogueIntelligence must not be set.

Memberof

DolbyDigitalPlusLoudnessControl

-

Optional mode

mode?: DolbyDigitalPlusLoudnessControlMode

Memberof

DolbyDigitalPlusLoudnessControl

-

Optional peakLimit

peakLimit?: number

The peak value in dB to use for loudness correction. This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other regulationType values peakLimit must not be set.

+

Optional mode

mode?: DolbyDigitalPlusLoudnessControlMode

Memberof

DolbyDigitalPlusLoudnessControl

+

Optional peakLimit

peakLimit?: number

The peak value in dB to use for loudness correction. This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other regulationType values peakLimit must not be set.

Memberof

DolbyDigitalPlusLoudnessControl

-

Optional regulationType

regulationType?: DolbyDigitalPlusLoudnessControlRegulationType

This is only allowed if the mode is CORRECTION. <th colspan=4 align="left"> Predefined values for each regulation type:
Regulation Type EBU R128 ATSC A/85 Fixed ATSC A/85 Agile
Limit Mode True Peak True Peak True Peak
Correction Mode PCM Normalization PCM Normalization Metadata Update
Peak Limit –3 dBTP –2 dBTP N/A
Dialogue Intelligence Off On On
Meter Mode ITU-R BS.1770-3 ITU-R BS.1770-3 ITU-R BS.1770-3
Speech Threshold 20 20 20
Dialogue Normalization -23 dB -24 dB Set to measured loudness

+

Optional regulationType

regulationType?: DolbyDigitalPlusLoudnessControlRegulationType

This is only allowed if the mode is CORRECTION. <th colspan=4 align="left"> Predefined values for each regulation type:
Regulation Type EBU R128 ATSC A/85 Fixed ATSC A/85 Agile
Limit Mode True Peak True Peak True Peak
Correction Mode PCM Normalization PCM Normalization Metadata Update
Peak Limit –3 dBTP –2 dBTP N/A
Dialogue Intelligence Off On On
Meter Mode ITU-R BS.1770-3 ITU-R BS.1770-3 ITU-R BS.1770-3
Speech Threshold 20 20 20
Dialogue Normalization -23 dB -24 dB Set to measured loudness

Memberof

DolbyDigitalPlusLoudnessControl

-

Settings

Member Visibility

Theme

On This Page

constructordialnormdialogueIntelligencemodepeakLimitregulationType
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordialnormdialogueIntelligencemodepeakLimitregulationType
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalPlusPreprocessing.html b/docs/classes/DolbyDigitalPlusPreprocessing.html index ce198070d..8459fb6a6 100644 --- a/docs/classes/DolbyDigitalPlusPreprocessing.html +++ b/docs/classes/DolbyDigitalPlusPreprocessing.html @@ -1,13 +1,13 @@ DolbyDigitalPlusPreprocessing | @bitmovin/api-sdk

Class DolbyDigitalPlusPreprocessing

Export

DolbyDigitalPlusPreprocessing

-

Constructors

constructor +

Constructors

constructor

Properties

dynamicRangeCompression? lfeLowPassFilter? ninetyDegreePhaseShift? threeDbAttenuation? -

Constructors

constructor

Properties

Optional dynamicRangeCompression

dynamicRangeCompression?: DolbyDigitalPlusDynamicRangeCompression

It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression. The values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.

+

Constructors

constructor

Properties

Optional dynamicRangeCompression

dynamicRangeCompression?: DolbyDigitalPlusDynamicRangeCompression

It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression. The values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.

Memberof

DolbyDigitalPlusPreprocessing

-

Optional lfeLowPassFilter

lfeLowPassFilter?: DolbyDigitalPlusLfeLowPassFilter

It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel. This is only allowed if the channelLayout contains a LFE channel.

+

Optional lfeLowPassFilter

lfeLowPassFilter?: DolbyDigitalPlusLfeLowPassFilter

It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel. This is only allowed if the channelLayout contains a LFE channel.

Memberof

DolbyDigitalPlusPreprocessing

-

Optional ninetyDegreePhaseShift

ninetyDegreePhaseShift?: DolbyDigitalPlusNinetyDegreePhaseShift

Memberof

DolbyDigitalPlusPreprocessing

-

Optional threeDbAttenuation

threeDbAttenuation?: DolbyDigitalPlusThreeDbAttenuation

Memberof

DolbyDigitalPlusPreprocessing

-

Settings

Member Visibility

Theme

On This Page

constructordynamicRangeCompressionlfeLowPassFilterninetyDegreePhaseShiftthreeDbAttenuation
\ No newline at end of file +

Optional ninetyDegreePhaseShift

ninetyDegreePhaseShift?: DolbyDigitalPlusNinetyDegreePhaseShift

Memberof

DolbyDigitalPlusPreprocessing

+

Optional threeDbAttenuation

threeDbAttenuation?: DolbyDigitalPlusThreeDbAttenuation

Memberof

DolbyDigitalPlusPreprocessing

+

Settings

Member Visibility

Theme

On This Page

constructordynamicRangeCompressionlfeLowPassFilterninetyDegreePhaseShiftthreeDbAttenuation
\ No newline at end of file diff --git a/docs/classes/DolbyDigitalPreprocessing.html b/docs/classes/DolbyDigitalPreprocessing.html index fa73b3284..b1522ceff 100644 --- a/docs/classes/DolbyDigitalPreprocessing.html +++ b/docs/classes/DolbyDigitalPreprocessing.html @@ -1,13 +1,13 @@ DolbyDigitalPreprocessing | @bitmovin/api-sdk

Class DolbyDigitalPreprocessing

Export

DolbyDigitalPreprocessing

-

Constructors

constructor +

Constructors

constructor

Properties

dynamicRangeCompression? lfeLowPassFilter? ninetyDegreePhaseShift? threeDbAttenuation? -

Constructors

constructor

Properties

Optional dynamicRangeCompression

dynamicRangeCompression?: DolbyDigitalDynamicRangeCompression

It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression. The values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.

+

Constructors

constructor

Properties

Optional dynamicRangeCompression

dynamicRangeCompression?: DolbyDigitalDynamicRangeCompression

It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression. The values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.

Memberof

DolbyDigitalPreprocessing

-

Optional lfeLowPassFilter

lfeLowPassFilter?: DolbyDigitalLfeLowPassFilter

It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel. This is only allowed if the channelLayout contains a LFE channel.

+

Optional lfeLowPassFilter

lfeLowPassFilter?: DolbyDigitalLfeLowPassFilter

It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel. This is only allowed if the channelLayout contains a LFE channel.

Memberof

DolbyDigitalPreprocessing

-

Optional ninetyDegreePhaseShift

ninetyDegreePhaseShift?: DolbyDigitalNinetyDegreePhaseShift

Memberof

DolbyDigitalPreprocessing

-

Optional threeDbAttenuation

threeDbAttenuation?: DolbyDigitalThreeDbAttenuation

Memberof

DolbyDigitalPreprocessing

-

Settings

Member Visibility

Theme

On This Page

constructordynamicRangeCompressionlfeLowPassFilterninetyDegreePhaseShiftthreeDbAttenuation
\ No newline at end of file +

Optional ninetyDegreePhaseShift

ninetyDegreePhaseShift?: DolbyDigitalNinetyDegreePhaseShift

Memberof

DolbyDigitalPreprocessing

+

Optional threeDbAttenuation

threeDbAttenuation?: DolbyDigitalThreeDbAttenuation

Memberof

DolbyDigitalPreprocessing

+

Settings

Member Visibility

Theme

On This Page

constructordynamicRangeCompressionlfeLowPassFilterninetyDegreePhaseShiftthreeDbAttenuation
\ No newline at end of file diff --git a/docs/classes/DolbyVisionInputStream.html b/docs/classes/DolbyVisionInputStream.html index 01c6c3ebf..e451c2fea 100644 --- a/docs/classes/DolbyVisionInputStream.html +++ b/docs/classes/DolbyVisionInputStream.html @@ -1,5 +1,5 @@ DolbyVisionInputStream | @bitmovin/api-sdk

Class DolbyVisionInputStream

Export

DolbyVisionInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,24 +12,24 @@ videoInputPath? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

Id of input (required)

+

Optional inputId

inputId?: string

Id of input (required)

Memberof

DolbyVisionInputStream

-

Optional metadataInputPath

metadataInputPath?: string

Path to Dolby Vision Metadata file. This field is required when the metadata is not embedded in the video input file.

+

Optional metadataInputPath

metadataInputPath?: string

Path to Dolby Vision Metadata file. This field is required when the metadata is not embedded in the video input file.

Memberof

DolbyVisionInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputStreamType = InputStreamType.DOLBY_VISION

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.DOLBY_VISION

Discriminator property for InputStream

Memberof

DolbyVisionInputStream

-

Optional videoInputPath

videoInputPath?: string

Path to Dolby Vision input video file. (required)

+

Optional videoInputPath

videoInputPath?: string

Path to Dolby Vision input video file. (required)

Memberof

DolbyVisionInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputIdmetadataInputPathmodifiedAtnametypevideoInputPath_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputIdmetadataInputPathmodifiedAtnametypevideoInputPath_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DolbyVisionMetadata.html b/docs/classes/DolbyVisionMetadata.html index 97758b3ec..79ba6435e 100644 --- a/docs/classes/DolbyVisionMetadata.html +++ b/docs/classes/DolbyVisionMetadata.html @@ -1,5 +1,5 @@ DolbyVisionMetadata | @bitmovin/api-sdk

Class DolbyVisionMetadata

Export

DolbyVisionMetadata

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,22 +9,22 @@ modifiedAt? name? profile? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional metadataInputStreamId

metadataInputStreamId?: string

ID of the Dolby Vision Metadata Ingest Input Stream which provides the XML Metadata file. Required if metadataSource is set to INPUT_STREAM.

+

Optional metadataInputStreamId

metadataInputStreamId?: string

ID of the Dolby Vision Metadata Ingest Input Stream which provides the XML Metadata file. Required if metadataSource is set to INPUT_STREAM.

Memberof

DolbyVisionMetadata

-

Optional metadataSource

metadataSource?: DolbyVisionMetadataSource

Dolby Vision Metadata Source (required)

+

Optional metadataSource

metadataSource?: DolbyVisionMetadataSource

Dolby Vision Metadata Source (required)

Memberof

DolbyVisionMetadata

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional profile

profile?: DolbyVisionProfile

Dolby Vision Profile (required)

+

Optional profile

profile?: DolbyVisionProfile

Dolby Vision Profile (required)

Memberof

DolbyVisionMetadata

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmetadataInputStreamIdmetadataSourcemodifiedAtnameprofile
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmetadataInputStreamIdmetadataSourcemodifiedAtnameprofile
\ No newline at end of file diff --git a/docs/classes/DolbyVisionMetadataIngestInputStream.html b/docs/classes/DolbyVisionMetadataIngestInputStream.html index 2b0ef8195..f33366816 100644 --- a/docs/classes/DolbyVisionMetadataIngestInputStream.html +++ b/docs/classes/DolbyVisionMetadataIngestInputStream.html @@ -1,5 +1,5 @@ DolbyVisionMetadataIngestInputStream | @bitmovin/api-sdk

Class DolbyVisionMetadataIngestInputStream

Export

DolbyVisionMetadataIngestInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -11,22 +11,22 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

Id of input (required)

+

Optional inputId

inputId?: string

Id of input (required)

Memberof

DolbyVisionMetadataIngestInputStream

-

Optional inputPath

inputPath?: string

Path to Dolby Vision Metadata file (required)

+

Optional inputPath

inputPath?: string

Path to Dolby Vision Metadata file (required)

Memberof

DolbyVisionMetadataIngestInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputStreamType = InputStreamType.SIDECAR_DOLBY_VISION_METADATA

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.SIDECAR_DOLBY_VISION_METADATA

Discriminator property for InputStream

Memberof

DolbyVisionMetadataIngestInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DolbyVisionMuxingConfiguration.html b/docs/classes/DolbyVisionMuxingConfiguration.html index 5334ac280..50f21a96a 100644 --- a/docs/classes/DolbyVisionMuxingConfiguration.html +++ b/docs/classes/DolbyVisionMuxingConfiguration.html @@ -1,5 +1,5 @@ DolbyVisionMuxingConfiguration | @bitmovin/api-sdk

Class DolbyVisionMuxingConfiguration

Export

DolbyVisionMuxingConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

trackSampleEntryName? -

Constructors

constructor

Properties

Optional trackSampleEntryName

trackSampleEntryName?: DolbyVisionTrackSampleEntryName

Memberof

DolbyVisionMuxingConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructortrackSampleEntryName
\ No newline at end of file +

Constructors

constructor

Properties

Optional trackSampleEntryName

trackSampleEntryName?: DolbyVisionTrackSampleEntryName

Memberof

DolbyVisionMuxingConfiguration

+

Settings

Member Visibility

Theme

On This Page

constructortrackSampleEntryName
\ No newline at end of file diff --git a/docs/classes/Domain.html b/docs/classes/Domain.html index 9c9540702..035139caa 100644 --- a/docs/classes/Domain.html +++ b/docs/classes/Domain.html @@ -1,5 +1,5 @@ Domain | @bitmovin/api-sdk

Class Domain

Export

Domain

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -7,18 +7,18 @@ modifiedAt? name? url? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional url

url?: string

Host where the player is allowed to play (required)

+

Optional url

url?: string

Host where the player is allowed to play (required)

Memberof

Domain

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameurl
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameurl
\ No newline at end of file diff --git a/docs/classes/DomainList.html b/docs/classes/DomainList.html index 41c673489..a262def28 100644 --- a/docs/classes/DomainList.html +++ b/docs/classes/DomainList.html @@ -1,5 +1,5 @@ DomainList | @bitmovin/api-sdk

Class DomainList

Export

DomainList

-

Constructors

constructor +

Constructors

constructor

Properties

domains? -

Constructors

constructor

Properties

Optional domains

domains?: Domain[]

Memberof

DomainList

-

Settings

Member Visibility

Theme

On This Page

constructordomains
\ No newline at end of file +

Constructors

constructor

Properties

Optional domains

domains?: Domain[]

Memberof

DomainList

+

Settings

Member Visibility

Theme

On This Page

constructordomains
\ No newline at end of file diff --git a/docs/classes/Drm.html b/docs/classes/Drm.html index ae90d8ac0..ef3ae9602 100644 --- a/docs/classes/Drm.html +++ b/docs/classes/Drm.html @@ -1,5 +1,5 @@ Drm | @bitmovin/api-sdk

Class Drm

Export

Drm

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,17 +9,17 @@ outputs? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameoutputs_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameoutputs_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DtsAudioConfiguration.html b/docs/classes/DtsAudioConfiguration.html index 9df6f71a3..acf5f10cc 100644 --- a/docs/classes/DtsAudioConfiguration.html +++ b/docs/classes/DtsAudioConfiguration.html @@ -1,5 +1,5 @@ DtsAudioConfiguration | @bitmovin/api-sdk

Class DtsAudioConfiguration

Export

DtsAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? createdAt? customData? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: DtsMode

There are two DTS modes available: DTS Express Audio (EXPRESS_AUDIO) and DTS Digital Surround (DIGITAL_SURROUND)

+

Optional mode

mode?: DtsMode

There are two DTS modes available: DTS Express Audio (EXPRESS_AUDIO) and DTS Digital Surround (DIGITAL_SURROUND)

Memberof

DtsAudioConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.DTS

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.DTS

Discriminator property for CodecConfiguration

Memberof

DtsAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecreatedAtcustomDatadescriptionidmodemodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecreatedAtcustomDatadescriptionidmodemodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DtsPassthroughAudioConfiguration.html b/docs/classes/DtsPassthroughAudioConfiguration.html index 6347e0abc..f8922df8d 100644 --- a/docs/classes/DtsPassthroughAudioConfiguration.html +++ b/docs/classes/DtsPassthroughAudioConfiguration.html @@ -1,5 +1,5 @@ DtsPassthroughAudioConfiguration | @bitmovin/api-sdk

Class DtsPassthroughAudioConfiguration

Export

DtsPassthroughAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,18 +9,18 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: CodecConfigType = CodecConfigType.DTS_PASSTHROUGH

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.DTS_PASSTHROUGH

Discriminator property for CodecConfiguration

Memberof

DtsPassthroughAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DtsXAudioConfiguration.html b/docs/classes/DtsXAudioConfiguration.html index 694152bf8..847f071f7 100644 --- a/docs/classes/DtsXAudioConfiguration.html +++ b/docs/classes/DtsXAudioConfiguration.html @@ -1,6 +1,6 @@ DtsXAudioConfiguration | @bitmovin/api-sdk

Class DtsXAudioConfiguration

The configuration for the DTS:X

Export

DtsXAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -16,28 +16,28 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: DtsXChannelLayout

Memberof

DtsXAudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional channelLayout

channelLayout?: DtsXChannelLayout

Memberof

DtsXAudioConfiguration

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional lkfsValue

lkfsValue?: number

Loudness relative to full scale (K-weighted).

+

Optional lkfsValue

lkfsValue?: number

Loudness relative to full scale (K-weighted).

Memberof

DtsXAudioConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional ottLoudnessMode

ottLoudnessMode?: OttLoudnessMode

Memberof

DtsXAudioConfiguration

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional ottLoudnessMode

ottLoudnessMode?: OttLoudnessMode

Memberof

DtsXAudioConfiguration

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Optional syncInterval

syncInterval?: number

Specifies the sync interval which ranges from 1 to 10

+

Optional syncInterval

syncInterval?: number

Specifies the sync interval which ranges from 1 to 10

Memberof

DtsXAudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.DTSX

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.DTSX

Discriminator property for CodecConfiguration

Memberof

DtsXAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidlkfsValuemodifiedAtnameottLoudnessModeratesyncIntervaltype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidlkfsValuemodifiedAtnameottLoudnessModeratesyncIntervaltype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DvbSubtitleConfiguration.html b/docs/classes/DvbSubtitleConfiguration.html index 0c73a06dd..c3bfafcd6 100644 --- a/docs/classes/DvbSubtitleConfiguration.html +++ b/docs/classes/DvbSubtitleConfiguration.html @@ -1,5 +1,5 @@ DvbSubtitleConfiguration | @bitmovin/api-sdk

Class DvbSubtitleConfiguration

Export

DvbSubtitleConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,18 +9,18 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: CodecConfigType = CodecConfigType.DVB_SUBTITLE

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.DVB_SUBTITLE

Discriminator property for CodecConfiguration

Memberof

DvbSubtitleConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/DvbSubtitleInputStream.html b/docs/classes/DvbSubtitleInputStream.html index b8a715c5d..6e8253d09 100644 --- a/docs/classes/DvbSubtitleInputStream.html +++ b/docs/classes/DvbSubtitleInputStream.html @@ -1,5 +1,5 @@ DvbSubtitleInputStream | @bitmovin/api-sdk

Class DvbSubtitleInputStream

Export

DvbSubtitleInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

ID of an Input resource defining the input storage

+

Optional inputId

inputId?: string

ID of an Input resource defining the input storage

Memberof

DvbSubtitleInputStream

-

Optional inputPath

inputPath?: string

Path to an input media file

+

Optional inputPath

inputPath?: string

Path to an input media file

Memberof

DvbSubtitleInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional position

position?: number

Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.

+

Optional position

position?: number

Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.

Memberof

DvbSubtitleInputStream

-

Optional selectionMode

selectionMode?: StreamSelectionMode

Specifies the strategy for selecting a stream from the input file. Supported values for VOD encodings: AUTO, POSITION_ABSOLUTE, SUBTITLE_RELATIVE. Supported values for LIVE encodings: POSITION_ABSOLUTE

+

Optional selectionMode

selectionMode?: StreamSelectionMode

Specifies the strategy for selecting a stream from the input file. Supported values for VOD encodings: AUTO, POSITION_ABSOLUTE, SUBTITLE_RELATIVE. Supported values for LIVE encodings: POSITION_ABSOLUTE

Memberof

DvbSubtitleInputStream

-

Readonly type

type: InputStreamType = InputStreamType.DVB_SUBTITLE

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.DVB_SUBTITLE

Discriminator property for InputStream

Memberof

DvbSubtitleInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnamepositionselectionModetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnamepositionselectionModetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Eac3AudioConfiguration.html b/docs/classes/Eac3AudioConfiguration.html index 74477ebec..2d203c4e0 100644 --- a/docs/classes/Eac3AudioConfiguration.html +++ b/docs/classes/Eac3AudioConfiguration.html @@ -1,5 +1,5 @@ Eac3AudioConfiguration | @bitmovin/api-sdk

Class Eac3AudioConfiguration

Export

Eac3AudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: Ac3ChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: Ac3ChannelLayout

Channel layout of the audio codec configuration

Memberof

Eac3AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional cutoffFrequency

cutoffFrequency?: number

The highest frequency that will pass the audio encoder. This value is optional.

+

Optional cutoffFrequency

cutoffFrequency?: number

The highest frequency that will pass the audio encoder. This value is optional.

Memberof

Eac3AudioConfiguration

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.EAC3

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.EAC3

Discriminator property for CodecConfiguration

Memberof

Eac3AudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatacutoffFrequencydescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatacutoffFrequencydescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/EbuR128SinglePassFilter.html b/docs/classes/EbuR128SinglePassFilter.html index 408147019..e5c5a2e23 100644 --- a/docs/classes/EbuR128SinglePassFilter.html +++ b/docs/classes/EbuR128SinglePassFilter.html @@ -1,5 +1,5 @@ EbuR128SinglePassFilter | @bitmovin/api-sdk

Class EbuR128SinglePassFilter

Export

EbuR128SinglePassFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional integratedLoudness

integratedLoudness?: number

Set the targeted integrated loudness value. Range is from '-70.0' to '-5.0'. Default value is '-24.0'. Value is measured in LUFS (Loudness Units, referenced to Full Scale)

+

Optional integratedLoudness

integratedLoudness?: number

Set the targeted integrated loudness value. Range is from '-70.0' to '-5.0'. Default value is '-24.0'. Value is measured in LUFS (Loudness Units, referenced to Full Scale)

Memberof

EbuR128SinglePassFilter

-

Optional loudnessRange

loudnessRange?: number

Set the targeted loudness range target. Range is from '1.0' to '20.0'. Default value is '7.0'. Loudness range measures the variation of loudness on a macroscopic time-scale in units of LU (Loudness Units). For programmes shorter than 1 minute, the use of the measure Loudness Range is not recommended due to too few data points (Loudness Range is based on the Short-term-Loudness values (3-seconds-window)).

+

Optional loudnessRange

loudnessRange?: number

Set the targeted loudness range target. Range is from '1.0' to '20.0'. Default value is '7.0'. Loudness range measures the variation of loudness on a macroscopic time-scale in units of LU (Loudness Units). For programmes shorter than 1 minute, the use of the measure Loudness Range is not recommended due to too few data points (Loudness Range is based on the Short-term-Loudness values (3-seconds-window)).

Memberof

EbuR128SinglePassFilter

-

Optional maximumTruePeakLevel

maximumTruePeakLevel?: number

Set maximum true peak. Range is from '-9.0' to '0.0'. Default value is '-2.0'. Values are measured in dBTP (db True Peak)

+

Optional maximumTruePeakLevel

maximumTruePeakLevel?: number

Set maximum true peak. Range is from '-9.0' to '0.0'. Default value is '-2.0'. Values are measured in dBTP (db True Peak)

Memberof

EbuR128SinglePassFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: FilterType = FilterType.EBU_R128_SINGLE_PASS

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.EBU_R128_SINGLE_PASS

Discriminator property for Filter

Memberof

EbuR128SinglePassFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidintegratedLoudnessloudnessRangemaximumTruePeakLevelmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidintegratedLoudnessloudnessRangemaximumTruePeakLevelmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/EgressInformation.html b/docs/classes/EgressInformation.html index 989832f29..787b141b0 100644 --- a/docs/classes/EgressInformation.html +++ b/docs/classes/EgressInformation.html @@ -1,12 +1,12 @@ EgressInformation | @bitmovin/api-sdk

Class EgressInformation

Export

EgressInformation

-

Constructors

constructor +

Constructors

constructor

Properties

bytes? category? outputRegion? outputType? -

Constructors

constructor

Properties

Optional bytes

bytes?: number

The number of bytes that have been transferred to the output (required)

+

Constructors

constructor

Properties

Optional bytes

bytes?: number

The number of bytes that have been transferred to the output (required)

Memberof

EgressInformation

-

Optional category

category?: EgressCategory

Memberof

EgressInformation

-

Optional outputRegion

outputRegion?: CloudRegion

Memberof

EgressInformation

-

Optional outputType

outputType?: OutputType

Memberof

EgressInformation

-

Settings

Member Visibility

Theme

On This Page

constructorbytescategoryoutputRegionoutputType
\ No newline at end of file +

Optional category

category?: EgressCategory

Memberof

EgressInformation

+

Optional outputRegion

outputRegion?: CloudRegion

Memberof

EgressInformation

+

Optional outputType

outputType?: OutputType

Memberof

EgressInformation

+

Settings

Member Visibility

Theme

On This Page

constructorbytescategoryoutputRegionoutputType
\ No newline at end of file diff --git a/docs/classes/EmailNotification.html b/docs/classes/EmailNotification.html index 16a8b8547..0dda0ad19 100644 --- a/docs/classes/EmailNotification.html +++ b/docs/classes/EmailNotification.html @@ -1,5 +1,5 @@ EmailNotification | @bitmovin/api-sdk

Class EmailNotification

Export

EmailNotification

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

category? customData? emails? @@ -11,20 +11,20 @@ resourceType? triggeredAt? type? -

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

Notification

-

Optional emails

emails?: string[]

Memberof

EmailNotification

-

Optional eventType

eventType?: string

Memberof

Notification

-

Optional id

id?: string

Id of the resource (required)

+

Optional emails

emails?: string[]

Memberof

EmailNotification

+

Optional eventType

eventType?: string

Memberof

Notification

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muted

muted?: boolean

Memberof

Notification

-

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

+

Optional muted

muted?: boolean

Memberof

Notification

+

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

Memberof

Notification

-

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

+

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

Memberof

Notification

-

Optional resourceType

resourceType?: string

Memberof

Notification

-

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

+

Optional resourceType

resourceType?: string

Memberof

Notification

+

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

Memberof

Notification

-

Optional type

type?: string

Memberof

Notification

-

Settings

Member Visibility

Theme

On This Page

constructorcategorycustomDataemailseventTypeidmutedresolveresourceIdresourceTypetriggeredAttype
\ No newline at end of file +

Optional type

type?: string

Memberof

Notification

+

Settings

Member Visibility

Theme

On This Page

constructorcategorycustomDataemailseventTypeidmutedresolveresourceIdresourceTypetriggeredAttype
\ No newline at end of file diff --git a/docs/classes/EmailNotificationWithStreamConditions.html b/docs/classes/EmailNotificationWithStreamConditions.html index 20d32b9f8..ff7d5bc18 100644 --- a/docs/classes/EmailNotificationWithStreamConditions.html +++ b/docs/classes/EmailNotificationWithStreamConditions.html @@ -1,5 +1,5 @@ EmailNotificationWithStreamConditions | @bitmovin/api-sdk

Class EmailNotificationWithStreamConditions

Export

EmailNotificationWithStreamConditions

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

category? conditions? customData? @@ -12,21 +12,21 @@ resourceType? triggeredAt? type? -

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

-

Optional conditions

conditions?: AbstractCondition

Memberof

EmailNotificationWithStreamConditions

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

+

Optional conditions

conditions?: AbstractCondition

Memberof

EmailNotificationWithStreamConditions

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

Notification

-

Optional emails

emails?: string[]

Memberof

EmailNotification

-

Optional eventType

eventType?: string

Memberof

Notification

-

Optional id

id?: string

Id of the resource (required)

+

Optional emails

emails?: string[]

Memberof

EmailNotification

+

Optional eventType

eventType?: string

Memberof

Notification

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muted

muted?: boolean

Memberof

Notification

-

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

+

Optional muted

muted?: boolean

Memberof

Notification

+

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

Memberof

Notification

-

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

+

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

Memberof

Notification

-

Optional resourceType

resourceType?: string

Memberof

Notification

-

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

+

Optional resourceType

resourceType?: string

Memberof

Notification

+

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

Memberof

Notification

-

Optional type

type?: string

Memberof

Notification

-

Settings

Member Visibility

Theme

On This Page

constructorcategoryconditionscustomDataemailseventTypeidmutedresolveresourceIdresourceTypetriggeredAttype
\ No newline at end of file +

Optional type

type?: string

Memberof

Notification

+

Settings

Member Visibility

Theme

On This Page

constructorcategoryconditionscustomDataemailseventTypeidmutedresolveresourceIdresourceTypetriggeredAttype
\ No newline at end of file diff --git a/docs/classes/EmailNotificationWithStreamConditionsRequest.html b/docs/classes/EmailNotificationWithStreamConditionsRequest.html index 9880cbd89..ce3f91349 100644 --- a/docs/classes/EmailNotificationWithStreamConditionsRequest.html +++ b/docs/classes/EmailNotificationWithStreamConditionsRequest.html @@ -1,12 +1,12 @@ EmailNotificationWithStreamConditionsRequest | @bitmovin/api-sdk

Class EmailNotificationWithStreamConditionsRequest

Export

EmailNotificationWithStreamConditionsRequest

-

Constructors

constructor +

Constructors

constructor

Properties

conditions? emails? muted? resolve? -

Constructors

constructor

Properties

Optional conditions

conditions?: AbstractCondition

Memberof

EmailNotificationWithStreamConditionsRequest

-

Optional emails

emails?: string[]

Memberof

EmailNotificationWithStreamConditionsRequest

-

Optional muted

muted?: boolean

Memberof

EmailNotificationWithStreamConditionsRequest

-

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

+

Constructors

constructor

Properties

Optional conditions

conditions?: AbstractCondition

Memberof

EmailNotificationWithStreamConditionsRequest

+

Optional emails

emails?: string[]

Memberof

EmailNotificationWithStreamConditionsRequest

+

Optional muted

muted?: boolean

Memberof

EmailNotificationWithStreamConditionsRequest

+

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

Memberof

EmailNotificationWithStreamConditionsRequest

-

Settings

Member Visibility

Theme

On This Page

constructorconditionsemailsmutedresolve
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorconditionsemailsmutedresolve
\ No newline at end of file diff --git a/docs/classes/Encoding.html b/docs/classes/Encoding.html index 237d0ee48..07e8a7176 100644 --- a/docs/classes/Encoding.html +++ b/docs/classes/Encoding.html @@ -1,5 +1,5 @@ Encoding | @bitmovin/api-sdk

Class Encoding

Export

Encoding

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cloudRegion? createdAt? customData? @@ -25,52 +25,52 @@ staticIpId? status? type? -

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: CloudRegion

Memberof

Encoding

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: CloudRegion

Memberof

Encoding

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional encoderVersion

encoderVersion?: string

Version of the encoder

+

Optional encoderVersion

encoderVersion?: string

Version of the encoder

Memberof

Encoding

-

Optional errorAt

errorAt?: Date

Timestamp when the encoding status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an 'ERROR'.

+

Optional errorAt

errorAt?: Date

Timestamp when the encoding status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an 'ERROR'.

Memberof

Encoding

-

Optional fallbackCloudRegions

fallbackCloudRegions?: CloudRegion[]

Specify a list of regions which are used in case the preferred region is down. Currently there are several restrictions. - The region has to be specific or AUTO - The region has to be for the same cloud provider as the default one - You can only configure at most 3 fallback regions

+

Optional fallbackCloudRegions

fallbackCloudRegions?: CloudRegion[]

Specify a list of regions which are used in case the preferred region is down. Currently there are several restrictions. - The region has to be specific or AUTO - The region has to be for the same cloud provider as the default one - You can only configure at most 3 fallback regions

Memberof

Encoding

-

Optional finishedAt

finishedAt?: Date

Timestamp when the encoding status changed to 'FINISHED', 'ERROR', 'CANCELED', or 'TRANSFER_ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for encodings which ran prior to the 1.50.0 REST API release.

+

Optional finishedAt

finishedAt?: Date

Timestamp when the encoding status changed to 'FINISHED', 'ERROR', 'CANCELED', or 'TRANSFER_ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for encodings which ran prior to the 1.50.0 REST API release.

Memberof

Encoding

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional infrastructure

infrastructure?: InfrastructureSettings

Memberof

Encoding

-

Optional labels

labels?: string[]

You may pass a list of groups associated with this encoding. This will enable you to group results in the statistics resource

+

Optional infrastructure

infrastructure?: InfrastructureSettings

Memberof

Encoding

+

Optional labels

labels?: string[]

You may pass a list of groups associated with this encoding. This will enable you to group results in the statistics resource

Memberof

Encoding

-

Optional liveOptionsType

liveOptionsType?: HD

The chosen live option type of the live encoding

+

Optional liveOptionsType

liveOptionsType?: HD

The chosen live option type of the live encoding

Memberof

Encoding

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional progress

progress?: number

Progress of the encoding in percent

+

Optional progress

progress?: number

Progress of the encoding in percent

Memberof

Encoding

-

Optional queuedAt

queuedAt?: Date

Timestamp when the encoding status changed to "QUEUED", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional queuedAt

queuedAt?: Date

Timestamp when the encoding status changed to "QUEUED", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Encoding

-

Optional runningAt

runningAt?: Date

Timestamp when the encoding status changed to "RUNNING", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional runningAt

runningAt?: Date

Timestamp when the encoding status changed to "RUNNING", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Encoding

-

Optional selectedCloudRegion

selectedCloudRegion?: CloudRegion

After the encoding has been started, this will contain the cloud region that was actually used. This will differ from cloudRegion if cloudRegion was set to an unspecific region (e.g. 'AUTO')

+

Optional selectedCloudRegion

selectedCloudRegion?: CloudRegion

After the encoding has been started, this will contain the cloud region that was actually used. This will differ from cloudRegion if cloudRegion was set to an unspecific region (e.g. 'AUTO')

Memberof

Encoding

-

Optional selectedEncoderVersion

selectedEncoderVersion?: string

After the encoding has been started, this will contain the encoder version that was actually used. Especially useful when starting an encoding with a version tag like STABLE or BETA.

+

Optional selectedEncoderVersion

selectedEncoderVersion?: string

After the encoding has been started, this will contain the encoder version that was actually used. Especially useful when starting an encoding with a version tag like STABLE or BETA.

Memberof

Encoding

-

Optional selectedEncodingMode

selectedEncodingMode?: EncodingMode

After the encoding has been started, this will contain the encoding mode that was actually used. Especially useful when encodingMode was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).

+

Optional selectedEncodingMode

selectedEncodingMode?: EncodingMode

After the encoding has been started, this will contain the encoding mode that was actually used. Especially useful when encodingMode was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).

Memberof

Encoding

-

Optional selectedFallbackCloudRegions

selectedFallbackCloudRegions?: CloudRegion[]

After the encoding has been started, this will contain the fallback cloud regions that were actually used. This will differ from fallbackCloudRegions if any of the fallbackCloudRegions were set to an unspecific region (e.g. 'AUTO')

+

Optional selectedFallbackCloudRegions

selectedFallbackCloudRegions?: CloudRegion[]

After the encoding has been started, this will contain the fallback cloud regions that were actually used. This will differ from fallbackCloudRegions if any of the fallbackCloudRegions were set to an unspecific region (e.g. 'AUTO')

Memberof

Encoding

-

Optional startedAt

startedAt?: Date

Timestamp when the encoding was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional startedAt

startedAt?: Date

Timestamp when the encoding was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Encoding

-

Optional staticIpId

staticIpId?: string

Specify an ID of a Static IP infrastructure resource this encoding should use. A Static IP cannot be used by multiple encodings at once. The encoding will go to an error state if the Static IP is already in use. This is currently only supported for live encodings.

+

Optional staticIpId

staticIpId?: string

Specify an ID of a Static IP infrastructure resource this encoding should use. A Static IP cannot be used by multiple encodings at once. The encoding will go to an error state if the Static IP is already in use. This is currently only supported for live encodings.

Memberof

Encoding

-

Optional status

status?: Status

The current status of the encoding.

+

Optional status

status?: Status

The current status of the encoding.

Memberof

Encoding

-

Optional type

type?: EncodingType

Type of the encoding

+

Optional type

type?: EncodingType

Type of the encoding

Memberof

Encoding

-

Settings

Member Visibility

Theme

On This Page

constructorcloudRegioncreatedAtcustomDatadescriptionencoderVersionerrorAtfallbackCloudRegionsfinishedAtidinfrastructurelabelsliveOptionsTypemodifiedAtnameprogressqueuedAtrunningAtselectedCloudRegionselectedEncoderVersionselectedEncodingModeselectedFallbackCloudRegionsstartedAtstaticIpIdstatustype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcloudRegioncreatedAtcustomDatadescriptionencoderVersionerrorAtfallbackCloudRegionsfinishedAtidinfrastructurelabelsliveOptionsTypemodifiedAtnameprogressqueuedAtrunningAtselectedCloudRegionselectedEncoderVersionselectedEncodingModeselectedFallbackCloudRegionsstartedAtstaticIpIdstatustype
\ No newline at end of file diff --git a/docs/classes/EncodingErrorDefinition.html b/docs/classes/EncodingErrorDefinition.html index 2a8bc04c3..b285f3b22 100644 --- a/docs/classes/EncodingErrorDefinition.html +++ b/docs/classes/EncodingErrorDefinition.html @@ -1,18 +1,18 @@ EncodingErrorDefinition | @bitmovin/api-sdk

Class EncodingErrorDefinition

Export

EncodingErrorDefinition

-

Constructors

constructor +

Constructors

constructor

Properties

category? code? description? message? retryHint? -

Constructors

constructor

Properties

Optional category

category?: string

The error category.

+

Constructors

constructor

Properties

Optional category

category?: string

The error category.

Memberof

EncodingErrorDefinition

-

Optional code

code?: number

The error code.

+

Optional code

code?: number

The error code.

Memberof

EncodingErrorDefinition

-

Optional description

description?: string

The returned error description.

+

Optional description

description?: string

The returned error description.

Memberof

EncodingErrorDefinition

-

Optional message

message?: string

The error message, optional. Can include placeholders like {1}, {2} which are replaced with the respective dependency when the error is thrown.

+

Optional message

message?: string

The error message, optional. Can include placeholders like {1}, {2} which are replaced with the respective dependency when the error is thrown.

Memberof

EncodingErrorDefinition

-

Optional retryHint

retryHint?: ErrorRetryHint

Indicates if the call that caused the error should be retried.

+

Optional retryHint

retryHint?: ErrorRetryHint

Indicates if the call that caused the error should be retried.

Memberof

EncodingErrorDefinition

-

Settings

Member Visibility

Theme

On This Page

constructorcategorycodedescriptionmessageretryHint
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcategorycodedescriptionmessageretryHint
\ No newline at end of file diff --git a/docs/classes/EncodingErrorEmailNotification.html b/docs/classes/EncodingErrorEmailNotification.html index 396893a20..61adc2e09 100644 --- a/docs/classes/EncodingErrorEmailNotification.html +++ b/docs/classes/EncodingErrorEmailNotification.html @@ -1,5 +1,5 @@ EncodingErrorEmailNotification | @bitmovin/api-sdk

Class EncodingErrorEmailNotification

Export

EncodingErrorEmailNotification

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

category? customData? emails? @@ -11,20 +11,20 @@ resourceType? triggeredAt? type? -

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

Notification

-

Optional emails

emails?: string[]

Memberof

EmailNotification

-

Optional eventType

eventType?: string

Memberof

Notification

-

Optional id

id?: string

Id of the resource (required)

+

Optional emails

emails?: string[]

Memberof

EmailNotification

+

Optional eventType

eventType?: string

Memberof

Notification

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muted

muted?: boolean

Memberof

Notification

-

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

+

Optional muted

muted?: boolean

Memberof

Notification

+

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

Memberof

Notification

-

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

+

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

Memberof

Notification

-

Optional resourceType

resourceType?: string

Memberof

Notification

-

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

+

Optional resourceType

resourceType?: string

Memberof

Notification

+

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

Memberof

Notification

-

Optional type

type?: string

Memberof

Notification

-

Settings

Member Visibility

Theme

On This Page

constructorcategorycustomDataemailseventTypeidmutedresolveresourceIdresourceTypetriggeredAttype
\ No newline at end of file +

Optional type

type?: string

Memberof

Notification

+

Settings

Member Visibility

Theme

On This Page

constructorcategorycustomDataemailseventTypeidmutedresolveresourceIdresourceTypetriggeredAttype
\ No newline at end of file diff --git a/docs/classes/EncodingOutput.html b/docs/classes/EncodingOutput.html index db276ef13..b8b55cfea 100644 --- a/docs/classes/EncodingOutput.html +++ b/docs/classes/EncodingOutput.html @@ -1,12 +1,12 @@ EncodingOutput | @bitmovin/api-sdk

Class EncodingOutput

Export

EncodingOutput

-

Constructors

constructor +

Constructors

constructor

Properties

acl? outputId? outputPath? -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL

Memberof

EncodingOutput

-

Optional outputId

outputId?: string

Id of the corresponding output (required)

+

Optional outputId

outputId?: string

Id of the corresponding output (required)

Memberof

EncodingOutput

-

Optional outputPath

outputPath?: string

Subdirectory where to save the files to (required)

+

Optional outputPath

outputPath?: string

Subdirectory where to save the files to (required)

Memberof

EncodingOutput

-

Settings

Member Visibility

Theme

On This Page

constructoracloutputIdoutputPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoracloutputIdoutputPath
\ No newline at end of file diff --git a/docs/classes/EncodingOutputPaths.html b/docs/classes/EncodingOutputPaths.html index 0a4e957e2..f59c6dc7c 100644 --- a/docs/classes/EncodingOutputPaths.html +++ b/docs/classes/EncodingOutputPaths.html @@ -1,7 +1,7 @@ EncodingOutputPaths | @bitmovin/api-sdk

Class EncodingOutputPaths

Export

EncodingOutputPaths

-

Constructors

constructor +

Constructors

constructor

Properties

output? paths? -

Constructors

constructor

Properties

Optional output

output?: Output

Memberof

EncodingOutputPaths

-

Optional paths

paths?: EncodingOutputPathsForOutput

Memberof

EncodingOutputPaths

-

Settings

Member Visibility

Theme

On This Page

constructoroutputpaths
\ No newline at end of file +

Constructors

constructor

Properties

Optional output

output?: Output

Memberof

EncodingOutputPaths

+

Optional paths

paths?: EncodingOutputPathsForOutput

Memberof

EncodingOutputPaths

+

Settings

Member Visibility

Theme

On This Page

constructoroutputpaths
\ No newline at end of file diff --git a/docs/classes/EncodingOutputPathsDashManifest.html b/docs/classes/EncodingOutputPathsDashManifest.html index 476798992..be8673150 100644 --- a/docs/classes/EncodingOutputPathsDashManifest.html +++ b/docs/classes/EncodingOutputPathsDashManifest.html @@ -1,9 +1,9 @@ EncodingOutputPathsDashManifest | @bitmovin/api-sdk

Class EncodingOutputPathsDashManifest

Export

EncodingOutputPathsDashManifest

-

Constructors

constructor +

Constructors

constructor

Properties

id? path? -

Constructors

constructor

Properties

Optional id

id?: string

Id of the dash manifest

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the dash manifest

Memberof

EncodingOutputPathsDashManifest

-

Optional path

path?: string

Path to the dash manifest on the given output

+

Optional path

path?: string

Path to the dash manifest on the given output

Memberof

EncodingOutputPathsDashManifest

-

Settings

Member Visibility

Theme

On This Page

constructoridpath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridpath
\ No newline at end of file diff --git a/docs/classes/EncodingOutputPathsForOutput.html b/docs/classes/EncodingOutputPathsForOutput.html index 684fe1dd0..9ee43382a 100644 --- a/docs/classes/EncodingOutputPathsForOutput.html +++ b/docs/classes/EncodingOutputPathsForOutput.html @@ -1,12 +1,12 @@ EncodingOutputPathsForOutput | @bitmovin/api-sdk

Class EncodingOutputPathsForOutput

Export

EncodingOutputPathsForOutput

-

Constructors

constructor +

Constructors

constructor

Properties

dashManifests? hlsManifests? smoothManifests? -

Constructors

constructor

Properties

Optional dashManifests

dashManifests?: EncodingOutputPathsDashManifest[]

Output paths for Dash manifests

+

Constructors

constructor

Properties

Optional dashManifests

dashManifests?: EncodingOutputPathsDashManifest[]

Output paths for Dash manifests

Memberof

EncodingOutputPathsForOutput

-

Optional hlsManifests

hlsManifests?: EncodingOutputPathsHlsManifest[]

Output paths for HLS manifests

+

Optional hlsManifests

hlsManifests?: EncodingOutputPathsHlsManifest[]

Output paths for HLS manifests

Memberof

EncodingOutputPathsForOutput

-

Optional smoothManifests

smoothManifests?: EncodingOutputPathsSmoothManifest[]

Output paths for Smooth manifests

+

Optional smoothManifests

smoothManifests?: EncodingOutputPathsSmoothManifest[]

Output paths for Smooth manifests

Memberof

EncodingOutputPathsForOutput

-

Settings

Member Visibility

Theme

On This Page

constructordashManifestshlsManifestssmoothManifests
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordashManifestshlsManifestssmoothManifests
\ No newline at end of file diff --git a/docs/classes/EncodingOutputPathsHlsManifest.html b/docs/classes/EncodingOutputPathsHlsManifest.html index 20a9ce989..eb2e92ca2 100644 --- a/docs/classes/EncodingOutputPathsHlsManifest.html +++ b/docs/classes/EncodingOutputPathsHlsManifest.html @@ -1,9 +1,9 @@ EncodingOutputPathsHlsManifest | @bitmovin/api-sdk

Class EncodingOutputPathsHlsManifest

Export

EncodingOutputPathsHlsManifest

-

Constructors

constructor +

Constructors

constructor

Properties

id? path? -

Constructors

constructor

Properties

Optional id

id?: string

Id of the HLS manifest

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the HLS manifest

Memberof

EncodingOutputPathsHlsManifest

-

Optional path

path?: string

Path to the index file of the HLS manifest on the given output

+

Optional path

path?: string

Path to the index file of the HLS manifest on the given output

Memberof

EncodingOutputPathsHlsManifest

-

Settings

Member Visibility

Theme

On This Page

constructoridpath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridpath
\ No newline at end of file diff --git a/docs/classes/EncodingOutputPathsSmoothManifest.html b/docs/classes/EncodingOutputPathsSmoothManifest.html index 5ffe3788e..6d24f3510 100644 --- a/docs/classes/EncodingOutputPathsSmoothManifest.html +++ b/docs/classes/EncodingOutputPathsSmoothManifest.html @@ -1,12 +1,12 @@ EncodingOutputPathsSmoothManifest | @bitmovin/api-sdk

Class EncodingOutputPathsSmoothManifest

Export

EncodingOutputPathsSmoothManifest

-

Constructors

constructor +

Constructors

constructor

Properties

clientManifestPath? id? serverManifestPath? -

Constructors

constructor

Properties

Optional clientManifestPath

clientManifestPath?: string

Path to the client manifest of the Smooth manifest on the given output

+

Constructors

constructor

Properties

Optional clientManifestPath

clientManifestPath?: string

Path to the client manifest of the Smooth manifest on the given output

Memberof

EncodingOutputPathsSmoothManifest

-

Optional id

id?: string

Id of the Smooth manifest

+

Optional id

id?: string

Id of the Smooth manifest

Memberof

EncodingOutputPathsSmoothManifest

-

Optional serverManifestPath

serverManifestPath?: string

Path to the server manifest of the Smooth manifest on the given output

+

Optional serverManifestPath

serverManifestPath?: string

Path to the server manifest of the Smooth manifest on the given output

Memberof

EncodingOutputPathsSmoothManifest

-

Settings

Member Visibility

Theme

On This Page

constructorclientManifestPathidserverManifestPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorclientManifestPathidserverManifestPath
\ No newline at end of file diff --git a/docs/classes/EncodingStatistics.html b/docs/classes/EncodingStatistics.html index 917b8763d..042a943bf 100644 --- a/docs/classes/EncodingStatistics.html +++ b/docs/classes/EncodingStatistics.html @@ -1,5 +1,5 @@ EncodingStatistics | @bitmovin/api-sdk

Class EncodingStatistics

Export

EncodingStatistics

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

billableEgressBytes? billableEncodingMinutes? billableFeatureMinutes? @@ -11,21 +11,21 @@ muxings? streams? timeEncoded? -

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Memberof

EncodingStatistics

-

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Memberof

EncodingStatistics

-

Optional billableFeatureMinutes

billableFeatureMinutes?: number

Billable minutes for the features.

+

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Memberof

EncodingStatistics

+

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Memberof

EncodingStatistics

+

Optional billableFeatureMinutes

billableFeatureMinutes?: number

Billable minutes for the features.

Memberof

EncodingStatistics

-

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for the muxings.

+

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for the muxings.

Memberof

EncodingStatistics

-

Optional bytesEgress

bytesEgress?: number

Egress output generated by file transfers in bytes (required)

+

Optional bytesEgress

bytesEgress?: number

Egress output generated by file transfers in bytes (required)

Memberof

EncodingStatistics

-

Optional bytesEncoded

bytesEncoded?: number

Bytes encoded for this encoding. (required)

+

Optional bytesEncoded

bytesEncoded?: number

Bytes encoded for this encoding. (required)

Memberof

EncodingStatistics

-

Optional date

date?: Date

Date, format. yyyy-MM-dd (required)

+

Optional date

date?: Date

Date, format. yyyy-MM-dd (required)

Memberof

EncodingStatistics

-

Optional features

features?: BillableEncodingFeatureMinutes[]

Memberof

EncodingStatistics

-

Optional muxings

muxings?: StatisticsPerMuxing[]

Memberof

EncodingStatistics

-

Optional streams

streams?: StatisticsPerStream[]

Memberof

EncodingStatistics

-

Optional timeEncoded

timeEncoded?: number

Time in seconds encoded for this encoding. (required)

+

Optional features

features?: BillableEncodingFeatureMinutes[]

Memberof

EncodingStatistics

+

Optional muxings

muxings?: StatisticsPerMuxing[]

Memberof

EncodingStatistics

+

Optional streams

streams?: StatisticsPerStream[]

Memberof

EncodingStatistics

+

Optional timeEncoded

timeEncoded?: number

Time in seconds encoded for this encoding. (required)

Memberof

EncodingStatistics

-

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableTransmuxingMinutesbytesEgressbytesEncodeddatefeaturesmuxingsstreamstimeEncoded
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableTransmuxingMinutesbytesEgressbytesEncodeddatefeaturesmuxingsstreamstimeEncoded
\ No newline at end of file diff --git a/docs/classes/EncodingStatisticsLive.html b/docs/classes/EncodingStatisticsLive.html index 547d19951..a734e2814 100644 --- a/docs/classes/EncodingStatisticsLive.html +++ b/docs/classes/EncodingStatisticsLive.html @@ -1,5 +1,5 @@ EncodingStatisticsLive | @bitmovin/api-sdk

Class EncodingStatisticsLive

Export

EncodingStatisticsLive

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

billableEgressBytes? billableEncodingMinutes? billableFeatureMinutes? @@ -11,21 +11,21 @@ muxings? streams? timeEncoded? -

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Memberof

EncodingStatistics

-

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Memberof

EncodingStatistics

-

Optional billableFeatureMinutes

billableFeatureMinutes?: number

Billable minutes for the features.

+

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Memberof

EncodingStatistics

+

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Memberof

EncodingStatistics

+

Optional billableFeatureMinutes

billableFeatureMinutes?: number

Billable minutes for the features.

Memberof

EncodingStatistics

-

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for the muxings.

+

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for the muxings.

Memberof

EncodingStatistics

-

Optional bytesEgress

bytesEgress?: number

Egress output generated by file transfers in bytes (required)

+

Optional bytesEgress

bytesEgress?: number

Egress output generated by file transfers in bytes (required)

Memberof

EncodingStatistics

-

Optional bytesEncoded

bytesEncoded?: number

Bytes encoded for this encoding. (required)

+

Optional bytesEncoded

bytesEncoded?: number

Bytes encoded for this encoding. (required)

Memberof

EncodingStatistics

-

Optional date

date?: Date

Date, format. yyyy-MM-dd (required)

+

Optional date

date?: Date

Date, format. yyyy-MM-dd (required)

Memberof

EncodingStatistics

-

Optional features

features?: BillableEncodingFeatureMinutes[]

Memberof

EncodingStatistics

-

Optional muxings

muxings?: StatisticsPerMuxing[]

Memberof

EncodingStatistics

-

Optional streams

streams?: StatisticsPerStream[]

Memberof

EncodingStatistics

-

Optional timeEncoded

timeEncoded?: number

Time in seconds encoded for this encoding. (required)

+

Optional features

features?: BillableEncodingFeatureMinutes[]

Memberof

EncodingStatistics

+

Optional muxings

muxings?: StatisticsPerMuxing[]

Memberof

EncodingStatistics

+

Optional streams

streams?: StatisticsPerStream[]

Memberof

EncodingStatistics

+

Optional timeEncoded

timeEncoded?: number

Time in seconds encoded for this encoding. (required)

Memberof

EncodingStatistics

-

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableTransmuxingMinutesbytesEgressbytesEncodeddatefeaturesmuxingsstreamstimeEncoded
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableTransmuxingMinutesbytesEgressbytesEncodeddatefeaturesmuxingsstreamstimeEncoded
\ No newline at end of file diff --git a/docs/classes/EncodingStatisticsVod.html b/docs/classes/EncodingStatisticsVod.html index d8784d136..2a52ec130 100644 --- a/docs/classes/EncodingStatisticsVod.html +++ b/docs/classes/EncodingStatisticsVod.html @@ -1,5 +1,5 @@ EncodingStatisticsVod | @bitmovin/api-sdk

Class EncodingStatisticsVod

Export

EncodingStatisticsVod

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

billableEgressBytes? billableEncodingMinutes? billableFeatureMinutes? @@ -13,25 +13,25 @@ streams? timeEncoded? timeEnqueued? -

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Memberof

EncodingStatistics

-

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Memberof

EncodingStatistics

-

Optional billableFeatureMinutes

billableFeatureMinutes?: number

Billable minutes for the features.

+

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Memberof

EncodingStatistics

+

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Memberof

EncodingStatistics

+

Optional billableFeatureMinutes

billableFeatureMinutes?: number

Billable minutes for the features.

Memberof

EncodingStatistics

-

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for the muxings.

+

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for the muxings.

Memberof

EncodingStatistics

-

Optional bytesEgress

bytesEgress?: number

Egress output generated by file transfers in bytes (required)

+

Optional bytesEgress

bytesEgress?: number

Egress output generated by file transfers in bytes (required)

Memberof

EncodingStatistics

-

Optional bytesEncoded

bytesEncoded?: number

Bytes encoded for this encoding. (required)

+

Optional bytesEncoded

bytesEncoded?: number

Bytes encoded for this encoding. (required)

Memberof

EncodingStatistics

-

Optional date

date?: Date

Date, format. yyyy-MM-dd (required)

+

Optional date

date?: Date

Date, format. yyyy-MM-dd (required)

Memberof

EncodingStatistics

-

Optional features

features?: BillableEncodingFeatureMinutes[]

Memberof

EncodingStatistics

-

Optional muxings

muxings?: StatisticsPerMuxing[]

Memberof

EncodingStatistics

-

Optional realtimeFactor

realtimeFactor?: number

The realtime factor. (required)

+

Optional features

features?: BillableEncodingFeatureMinutes[]

Memberof

EncodingStatistics

+

Optional muxings

muxings?: StatisticsPerMuxing[]

Memberof

EncodingStatistics

+

Optional realtimeFactor

realtimeFactor?: number

The realtime factor. (required)

Memberof

EncodingStatisticsVod

-

Optional streams

streams?: StatisticsPerStream[]

Memberof

EncodingStatistics

-

Optional timeEncoded

timeEncoded?: number

Time in seconds encoded for this encoding. (required)

+

Optional streams

streams?: StatisticsPerStream[]

Memberof

EncodingStatistics

+

Optional timeEncoded

timeEncoded?: number

Time in seconds encoded for this encoding. (required)

Memberof

EncodingStatistics

-

Optional timeEnqueued

timeEnqueued?: number

Time in seconds encoded for this encoding. (required)

+

Optional timeEnqueued

timeEnqueued?: number

Time in seconds encoded for this encoding. (required)

Memberof

EncodingStatisticsVod

-

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableTransmuxingMinutesbytesEgressbytesEncodeddatefeaturesmuxingsrealtimeFactorstreamstimeEncodedtimeEnqueued
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableTransmuxingMinutesbytesEgressbytesEncodeddatefeaturesmuxingsrealtimeFactorstreamstimeEncodedtimeEnqueued
\ No newline at end of file diff --git a/docs/classes/EncodingStats.html b/docs/classes/EncodingStats.html index 9f3eede78..146c4f100 100644 --- a/docs/classes/EncodingStats.html +++ b/docs/classes/EncodingStats.html @@ -1,5 +1,5 @@ EncodingStats | @bitmovin/api-sdk

Class EncodingStats

Export

EncodingStats

-

Constructors

constructor +

Constructors

constructor

Properties

billableEgressBytes? billableEncodingMinutes? billableFeatureMinutes? @@ -13,30 +13,30 @@ muxings? streams? timeEncoded? -

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Billable egress output

+

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Billable egress output

Memberof

EncodingStats

-

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Detailed statistics per stream

+

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Detailed statistics per stream

Memberof

EncodingStats

-

Optional billableFeatureMinutes

billableFeatureMinutes?: number

Billable feature minutes

+

Optional billableFeatureMinutes

billableFeatureMinutes?: number

Billable feature minutes

Memberof

EncodingStats

-

Optional billableMinutes

billableMinutes?: number

Billable minutes

+

Optional billableMinutes

billableMinutes?: number

Billable minutes

Memberof

EncodingStats

-

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable transmuxing minutes (required)

+

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable transmuxing minutes (required)

Memberof

EncodingStats

-

Optional bytesEncoded

bytesEncoded?: number

Total bytes encoded

+

Optional bytesEncoded

bytesEncoded?: number

Total bytes encoded

Memberof

EncodingStats

-

Optional date

date?: Date

Date, format. yyyy-MM-dd

+

Optional date

date?: Date

Date, format. yyyy-MM-dd

Memberof

EncodingStats

-

Optional downloadedSize

downloadedSize?: number

Downloaded size of the input file

+

Optional downloadedSize

downloadedSize?: number

Downloaded size of the input file

Memberof

EncodingStats

-

Optional encodingId

encodingId?: string

The id of the encoding (required)

+

Optional encodingId

encodingId?: string

The id of the encoding (required)

Memberof

EncodingStats

-

Optional features

features?: BillableEncodingFeatureMinutes[]

Detailed statistics per feature

+

Optional features

features?: BillableEncodingFeatureMinutes[]

Detailed statistics per feature

Memberof

EncodingStats

-

Optional muxings

muxings?: StatisticsPerMuxing[]

Detailed statistics per muxing (required)

+

Optional muxings

muxings?: StatisticsPerMuxing[]

Detailed statistics per muxing (required)

Memberof

EncodingStats

-

Optional streams

streams?: StatisticsPerStream[]

Detailed statistics per stream (required)

+

Optional streams

streams?: StatisticsPerStream[]

Detailed statistics per stream (required)

Memberof

EncodingStats

-

Optional timeEncoded

timeEncoded?: number

Total time encoded

+

Optional timeEncoded

timeEncoded?: number

Total time encoded

Memberof

EncodingStats

-

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableMinutesbillableTransmuxingMinutesbytesEncodeddatedownloadedSizeencodingIdfeaturesmuxingsstreamstimeEncoded
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableMinutesbillableTransmuxingMinutesbytesEncodeddatedownloadedSizeencodingIdfeaturesmuxingsstreamstimeEncoded
\ No newline at end of file diff --git a/docs/classes/EncodingStreamInput.html b/docs/classes/EncodingStreamInput.html index 762c47b2e..76bbd2b90 100644 --- a/docs/classes/EncodingStreamInput.html +++ b/docs/classes/EncodingStreamInput.html @@ -1,11 +1,11 @@ EncodingStreamInput | @bitmovin/api-sdk

Class EncodingStreamInput

Export

EncodingStreamInput

-

Constructors

constructor +

Constructors

constructor

Properties

details? inputId? inputPath? -

Constructors

constructor

Properties

Optional details

details?: EncodingStreamInputDetails

Memberof

EncodingStreamInput

-

Optional inputId

inputId?: string

Input id (required)

+

Constructors

constructor

Properties

Optional details

details?: EncodingStreamInputDetails

Memberof

EncodingStreamInput

+

Optional inputId

inputId?: string

Input id (required)

Memberof

EncodingStreamInput

-

Optional inputPath

inputPath?: string

Path to media file (required)

+

Optional inputPath

inputPath?: string

Path to media file (required)

Memberof

EncodingStreamInput

-

Settings

Member Visibility

Theme

On This Page

constructordetailsinputIdinputPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordetailsinputIdinputPath
\ No newline at end of file diff --git a/docs/classes/EncodingStreamInputDetails.html b/docs/classes/EncodingStreamInputDetails.html index c523be70b..c06939138 100644 --- a/docs/classes/EncodingStreamInputDetails.html +++ b/docs/classes/EncodingStreamInputDetails.html @@ -1,5 +1,5 @@ EncodingStreamInputDetails | @bitmovin/api-sdk

Class EncodingStreamInputDetails

Export

EncodingStreamInputDetails

-

Constructors

constructor +

Constructors

constructor

Properties

audioStreams? bitrate? duration? @@ -10,24 +10,24 @@ subtitleStreams? tags? videoStreams? -

Constructors

constructor

Properties

Optional audioStreams

audioStreams?: AudioStream[]

Audio stream in the input file

+

Constructors

constructor

Properties

Optional audioStreams

audioStreams?: AudioStream[]

Audio stream in the input file

Memberof

EncodingStreamInputDetails

-

Optional bitrate

bitrate?: number

Bitrate in bps

+

Optional bitrate

bitrate?: number

Bitrate in bps

Memberof

EncodingStreamInputDetails

-

Optional duration

duration?: number

Duration in seconds

+

Optional duration

duration?: number

Duration in seconds

Memberof

EncodingStreamInputDetails

-

Optional formatName

formatName?: string

Format name

+

Optional formatName

formatName?: string

Format name

Memberof

EncodingStreamInputDetails

-

Optional metaStreams

metaStreams?: MediaStream[]

Meta data streams in the input file

+

Optional metaStreams

metaStreams?: MediaStream[]

Meta data streams in the input file

Memberof

EncodingStreamInputDetails

-

Optional size

size?: number

Input file size in bytes

+

Optional size

size?: number

Input file size in bytes

Memberof

EncodingStreamInputDetails

-

Optional startTime

startTime?: number

The start time in seconds

+

Optional startTime

startTime?: number

The start time in seconds

Memberof

EncodingStreamInputDetails

-

Optional subtitleStreams

subtitleStreams?: SubtitleStream[]

Subtitle streams in the input file

+

Optional subtitleStreams

subtitleStreams?: SubtitleStream[]

Subtitle streams in the input file

Memberof

EncodingStreamInputDetails

-

Optional tags

tags?: {
    [key: string]: any;
}

Additional metadata saved in the input file

+

Optional tags

tags?: {
    [key: string]: any;
}

Additional metadata saved in the input file

Type declaration

  • [key: string]: any

Memberof

EncodingStreamInputDetails

-

Optional videoStreams

videoStreams?: VideoStream[]

Video streams in the input file

+

Optional videoStreams

videoStreams?: VideoStream[]

Video streams in the input file

Memberof

EncodingStreamInputDetails

-

Settings

Member Visibility

Theme

On This Page

constructoraudioStreamsbitratedurationformatNamemetaStreamssizestartTimesubtitleStreamstagsvideoStreams
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioStreamsbitratedurationformatNamemetaStreamssizestartTimesubtitleStreamstagsvideoStreams
\ No newline at end of file diff --git a/docs/classes/EnhancedDeinterlaceFilter.html b/docs/classes/EnhancedDeinterlaceFilter.html index af2f67127..6cb889f2e 100644 --- a/docs/classes/EnhancedDeinterlaceFilter.html +++ b/docs/classes/EnhancedDeinterlaceFilter.html @@ -1,5 +1,5 @@ EnhancedDeinterlaceFilter | @bitmovin/api-sdk

Class EnhancedDeinterlaceFilter

Export

EnhancedDeinterlaceFilter

-

Hierarchy (view full)

  • Filter
    • EnhancedDeinterlaceFilter

Constructors

constructor +

Hierarchy (view full)

  • Filter
    • EnhancedDeinterlaceFilter

Constructors

constructor

Properties

autoEnable? createdAt? customData? @@ -12,21 +12,21 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional autoEnable

autoEnable?: EnhancedDeinterlaceAutoEnable

Memberof

EnhancedDeinterlaceFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional autoEnable

autoEnable?: EnhancedDeinterlaceAutoEnable

Memberof

EnhancedDeinterlaceFilter

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: EnhancedDeinterlaceMode

Memberof

EnhancedDeinterlaceFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional mode

mode?: EnhancedDeinterlaceMode

Memberof

EnhancedDeinterlaceFilter

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional parity

parity?: EnhancedDeinterlaceParity

Memberof

EnhancedDeinterlaceFilter

-

Readonly type

type: FilterType = FilterType.ENHANCED_DEINTERLACE

Discriminator property for Filter

+

Optional parity

parity?: EnhancedDeinterlaceParity

Memberof

EnhancedDeinterlaceFilter

+

Readonly type

type: FilterType = FilterType.ENHANCED_DEINTERLACE

Discriminator property for Filter

Memberof

EnhancedDeinterlaceFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorautoEnablecreatedAtcustomDatadescriptionidmodemodifiedAtnameparitytype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorautoEnablecreatedAtcustomDatadescriptionidmodemodifiedAtnameparitytype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/EnhancedWatermarkFilter.html b/docs/classes/EnhancedWatermarkFilter.html index d7d52662e..62358082d 100644 --- a/docs/classes/EnhancedWatermarkFilter.html +++ b/docs/classes/EnhancedWatermarkFilter.html @@ -1,5 +1,5 @@ EnhancedWatermarkFilter | @bitmovin/api-sdk

Class EnhancedWatermarkFilter

Export

EnhancedWatermarkFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bottom? createdAt? customData? @@ -18,35 +18,35 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bottom

bottom?: number

Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.

+

Constructors

constructor

Properties

Optional bottom

bottom?: number

Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.

Memberof

EnhancedWatermarkFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional height

height?: number

Desired height of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it

+

Optional height

height?: number

Desired height of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it

Memberof

EnhancedWatermarkFilter

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional image

image?: string

URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)

+

Optional image

image?: string

URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)

Memberof

EnhancedWatermarkFilter

-

Optional left

left?: number

Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.

+

Optional left

left?: number

Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.

Memberof

EnhancedWatermarkFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional opacity

opacity?: number

Opacity to apply on the watermark image. Valid values are from 0.0 (completely transparent) to 1.0 (not transparent at all)

+

Optional opacity

opacity?: number

Opacity to apply on the watermark image. Valid values are from 0.0 (completely transparent) to 1.0 (not transparent at all)

Memberof

EnhancedWatermarkFilter

-

Optional right

right?: number

Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.

+

Optional right

right?: number

Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.

Memberof

EnhancedWatermarkFilter

-

Optional top

top?: number

Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.

+

Optional top

top?: number

Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.

Memberof

EnhancedWatermarkFilter

-

Readonly type

type: FilterType = FilterType.ENHANCED_WATERMARK

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.ENHANCED_WATERMARK

Discriminator property for Filter

Memberof

EnhancedWatermarkFilter

-

Optional unit

unit?: PositionUnit

Memberof

EnhancedWatermarkFilter

-

Optional width

width?: number

Desired width of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it

+

Optional unit

unit?: PositionUnit

Memberof

EnhancedWatermarkFilter

+

Optional width

width?: number

Desired width of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it

Memberof

EnhancedWatermarkFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbottomcreatedAtcustomDatadescriptionheightidimageleftmodifiedAtnameopacityrighttoptypeunitwidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbottomcreatedAtcustomDatadescriptionheightidimageleftmodifiedAtnameopacityrighttoptypeunitwidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ErrorDetails.html b/docs/classes/ErrorDetails.html index f37942beb..a8b430525 100644 --- a/docs/classes/ErrorDetails.html +++ b/docs/classes/ErrorDetails.html @@ -1,15 +1,15 @@ ErrorDetails | @bitmovin/api-sdk

Class ErrorDetails

Export

ErrorDetails

-

Constructors

constructor +

Constructors

constructor

Properties

category? code? retryHint? text? -

Constructors

constructor

Properties

Optional category

category?: string

Error group name (required)

+

Constructors

constructor

Properties

Optional category

category?: string

Error group name (required)

Memberof

ErrorDetails

-

Optional code

code?: number

Specific error code (required)

+

Optional code

code?: number

Specific error code (required)

Memberof

ErrorDetails

-

Optional retryHint

retryHint?: RetryHint

Information if the encoding could potentially succeed when retrying. (required)

+

Optional retryHint

retryHint?: RetryHint

Information if the encoding could potentially succeed when retrying. (required)

Memberof

ErrorDetails

-

Optional text

text?: string

Detailed error message (required)

+

Optional text

text?: string

Detailed error message (required)

Memberof

ErrorDetails

-

Settings

Member Visibility

Theme

On This Page

constructorcategorycoderetryHinttext
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcategorycoderetryHinttext
\ No newline at end of file diff --git a/docs/classes/FairPlayDrm.html b/docs/classes/FairPlayDrm.html index ba9e869dc..96a7bee45 100644 --- a/docs/classes/FairPlayDrm.html +++ b/docs/classes/FairPlayDrm.html @@ -1,5 +1,5 @@ FairPlayDrm | @bitmovin/api-sdk

Class FairPlayDrm

Export

FairPlayDrm

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -13,25 +13,25 @@ uri? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional iv

iv?: string

16 byte initialization vector (required)

+

Optional iv

iv?: string

16 byte initialization vector (required)

Memberof

FairPlayDrm

-

Optional key

key?: string

16 byte Encryption key, 32 hexadecimal characters (required)

+

Optional key

key?: string

16 byte Encryption key, 32 hexadecimal characters (required)

Memberof

FairPlayDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Readonly type

type: DrmType = DrmType.FAIRPLAY

Discriminator property for Drm

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Readonly type

type: DrmType = DrmType.FAIRPLAY

Discriminator property for Drm

Memberof

FairPlayDrm

-

Optional uri

uri?: string

Url of the licensing server

+

Optional uri

uri?: string

Url of the licensing server

Memberof

FairPlayDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidivkeymodifiedAtnameoutputstypeuri_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidivkeymodifiedAtnameoutputstypeuri_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/FileInputStream.html b/docs/classes/FileInputStream.html index 610912d4e..1c2c645c8 100644 --- a/docs/classes/FileInputStream.html +++ b/docs/classes/FileInputStream.html @@ -1,5 +1,5 @@ FileInputStream | @bitmovin/api-sdk

Class FileInputStream

Export

FileInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,23 +12,23 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional fileType

fileType?: FileInputStreamType

Memberof

FileInputStream

-

Optional id

id?: string

Id of the resource (required)

+

Optional fileType

fileType?: FileInputStreamType

Memberof

FileInputStream

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

Id of input (required)

+

Optional inputId

inputId?: string

Id of input (required)

Memberof

FileInputStream

-

Optional inputPath

inputPath?: string

Path to file (required)

+

Optional inputPath

inputPath?: string

Path to file (required)

Memberof

FileInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputStreamType = InputStreamType.FILE

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.FILE

Discriminator property for InputStream

Memberof

FileInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionfileTypeidinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionfileTypeidinputIdinputPathmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Filter.html b/docs/classes/Filter.html index 3d48629ed..1b11ae6a0 100644 --- a/docs/classes/Filter.html +++ b/docs/classes/Filter.html @@ -1,5 +1,5 @@ Filter | @bitmovin/api-sdk

Class Filter

Export

Filter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,16 +8,16 @@ name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Fmp4Muxing.html b/docs/classes/Fmp4Muxing.html index c8a4f27e4..4d1b34682 100644 --- a/docs/classes/Fmp4Muxing.html +++ b/docs/classes/Fmp4Muxing.html @@ -1,5 +1,5 @@ Fmp4Muxing | @bitmovin/api-sdk

Class Fmp4Muxing

Export

Fmp4Muxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -24,46 +24,46 @@ writeDurationPerSample? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional initSegmentName

initSegmentName?: string

Init segment name

+

Optional initSegmentName

initSegmentName?: string

Init segment name

Memberof

Fmp4Muxing

-

Optional initSegmentNameTemplate

initSegmentNameTemplate?: string

Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.

+

Optional initSegmentNameTemplate

initSegmentNameTemplate?: string

Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.

Memberof

Fmp4Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional ptsAlignMode

ptsAlignMode?: ALIGN_ZERO_NEGATIVE_CTO

Alignment mode for composition / presentation timestamps (CTS/PTS). Only applies to h.264 and h.265

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional ptsAlignMode

ptsAlignMode?: ALIGN_ZERO_NEGATIVE_CTO

Alignment mode for composition / presentation timestamps (CTS/PTS). Only applies to h.264 and h.265

Memberof

Fmp4Muxing

-

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds (required)

+

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds (required)

Memberof

Fmp4Muxing

-

Optional segmentNaming

segmentNaming?: string

Segment naming policy

+

Optional segmentNaming

segmentNaming?: string

Segment naming policy

Memberof

Fmp4Muxing

-

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

+

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

Memberof

Fmp4Muxing

-

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

+

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

Memberof

Fmp4Muxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.FMP4

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.FMP4

Discriminator property for Muxing

Memberof

Fmp4Muxing

-

Optional writeDurationPerSample

writeDurationPerSample?: boolean

Writes the duration per sample into the sample entry in the Track Fragment Run Box. This could help to fix playback issues on legacy players. Enabling this flag increases the muxing overhead by 4 bytes per sample/frame.

+

Optional writeDurationPerSample

writeDurationPerSample?: boolean

Writes the duration per sample into the sample entry in the Track Fragment Run Box. This could help to fix playback issues on legacy players. Enabling this flag increases the muxing overhead by 4 bytes per sample/frame.

Memberof

Fmp4Muxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredByinitSegmentNameinitSegmentNameTemplatemaxBitrateminBitratemodifiedAtnameoutputsptsAlignModesegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstreamConditionsModestreamstypewriteDurationPerSample_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredByinitSegmentNameinitSegmentNameTemplatemaxBitrateminBitratemodifiedAtnameoutputsptsAlignModesegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstreamConditionsModestreamstypewriteDurationPerSample_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Fmp4MuxingInformation.html b/docs/classes/Fmp4MuxingInformation.html index 529ab2bad..8432545cf 100644 --- a/docs/classes/Fmp4MuxingInformation.html +++ b/docs/classes/Fmp4MuxingInformation.html @@ -1,5 +1,5 @@ Fmp4MuxingInformation | @bitmovin/api-sdk

Class Fmp4MuxingInformation

Export

Fmp4MuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

FragmentedMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

FragmentedMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

FragmentedMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

FragmentedMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

FragmentedMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

FragmentedMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

FragmentedMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/FragmentedMuxingInformation.html b/docs/classes/FragmentedMuxingInformation.html index af833880e..690515513 100644 --- a/docs/classes/FragmentedMuxingInformation.html +++ b/docs/classes/FragmentedMuxingInformation.html @@ -1,5 +1,5 @@ FragmentedMuxingInformation | @bitmovin/api-sdk

Class FragmentedMuxingInformation

Export

FragmentedMuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

FragmentedMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

FragmentedMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

FragmentedMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

FragmentedMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

FragmentedMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

FragmentedMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

FragmentedMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/FrameIdId3Tag.html b/docs/classes/FrameIdId3Tag.html index d62e97cc4..07145ab0c 100644 --- a/docs/classes/FrameIdId3Tag.html +++ b/docs/classes/FrameIdId3Tag.html @@ -1,5 +1,5 @@ FrameIdId3Tag | @bitmovin/api-sdk

Class FrameIdId3Tag

Export

FrameIdId3Tag

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bytes? createdAt? customData? @@ -14,27 +14,27 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bytes

bytes?: string

Base64 Encoded Data (required)

+

Constructors

constructor

Properties

Optional bytes

bytes?: string

Base64 Encoded Data (required)

Memberof

FrameIdId3Tag

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional frame

frame?: number

Frame number at which the Tag should be inserted

+

Optional frame

frame?: number

Frame number at which the Tag should be inserted

Memberof

Id3Tag

-

Optional frameId

frameId?: string

4 character long Frame ID (required)

+

Optional frameId

frameId?: string

4 character long Frame ID (required)

Memberof

FrameIdId3Tag

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional positionMode

positionMode?: Id3TagPositionMode

Memberof

Id3Tag

-

Optional time

time?: number

Time in seconds where the Tag should be inserted

+

Optional positionMode

positionMode?: Id3TagPositionMode

Memberof

Id3Tag

+

Optional time

time?: number

Time in seconds where the Tag should be inserted

Memberof

Id3Tag

-

Readonly type

type: Id3TagType = Id3TagType.FRAME_ID

Discriminator property for Id3Tag

+

Readonly type

type: Id3TagType = Id3TagType.FRAME_ID

Discriminator property for Id3Tag

Memberof

FrameIdId3Tag

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    FRAME_ID: string;
    PLAIN_TEXT: string;
    RAW: string;
} = ...

Type declaration

  • FRAME_ID: string
  • PLAIN_TEXT: string
  • RAW: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbytescreatedAtcustomDatadescriptionframeframeIdidmodifiedAtnamepositionModetimetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    FRAME_ID: string;
    PLAIN_TEXT: string;
    RAW: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbytescreatedAtcustomDatadescriptionframeframeIdidmodifiedAtnamepositionModetimetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/FtpInput.html b/docs/classes/FtpInput.html index 5e51340a3..f6816f30d 100644 --- a/docs/classes/FtpInput.html +++ b/docs/classes/FtpInput.html @@ -1,5 +1,5 @@ FtpInput | @bitmovin/api-sdk

Class FtpInput

Export

FtpInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -15,30 +15,30 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Host URL or IP of the FTP server (required)

+

Optional host

host?: string

Host URL or IP of the FTP server (required)

Memberof

FtpInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional passive

passive?: boolean

Use passive mode. Default is true.

+

Optional passive

passive?: boolean

Use passive mode. Default is true.

Memberof

FtpInput

-

Optional password

password?: string

Your FTP password

+

Optional password

password?: string

Your FTP password

Memberof

FtpInput

-

Optional port

port?: number

Port to use, standard for FTP: 21

+

Optional port

port?: number

Port to use, standard for FTP: 21

Memberof

FtpInput

-

Optional remoteVerificationEnabled

remoteVerificationEnabled?: boolean

Ensure that connections originate from the declared ftp host. Default is true.

+

Optional remoteVerificationEnabled

remoteVerificationEnabled?: boolean

Ensure that connections originate from the declared ftp host. Default is true.

Memberof

FtpInput

-

Readonly type

type: InputType = InputType.FTP

Discriminator property for Input

+

Readonly type

type: InputType = InputType.FTP

Discriminator property for Input

Memberof

FtpInput

-

Optional username

username?: string

Your FTP Username

+

Optional username

username?: string

Your FTP Username

Memberof

FtpInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepassivepasswordportremoteVerificationEnabledtypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepassivepasswordportremoteVerificationEnabledtypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/FtpOutput.html b/docs/classes/FtpOutput.html index a720bdb2c..19b0a82e4 100644 --- a/docs/classes/FtpOutput.html +++ b/docs/classes/FtpOutput.html @@ -1,5 +1,5 @@ FtpOutput | @bitmovin/api-sdk

Class FtpOutput

Export

FtpOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -17,34 +17,34 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Host URL or IP of the FTP server (required)

+

Optional host

host?: string

Host URL or IP of the FTP server (required)

Memberof

FtpOutput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional maxConcurrentConnections

maxConcurrentConnections?: number

Restrict maximum concurrent connections. Requires at least version 1.1.0.

+

Optional maxConcurrentConnections

maxConcurrentConnections?: number

Restrict maximum concurrent connections. Requires at least version 1.1.0.

Memberof

FtpOutput

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional passive

passive?: boolean

Use passive mode. Default is true.

+

Optional passive

passive?: boolean

Use passive mode. Default is true.

Memberof

FtpOutput

-

Optional password

password?: string

Your FTP password

+

Optional password

password?: string

Your FTP password

Memberof

FtpOutput

-

Optional port

port?: number

Port to use, standard for FTP: 21

+

Optional port

port?: number

Port to use, standard for FTP: 21

Memberof

FtpOutput

-

Optional transferVersion

transferVersion?: TransferVersion

Controls which transfer version should be used

+

Optional transferVersion

transferVersion?: TransferVersion

Controls which transfer version should be used

Memberof

FtpOutput

-

Readonly type

type: OutputType = OutputType.FTP

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.FTP

Discriminator property for Output

Memberof

FtpOutput

-

Optional username

username?: string

Your FTP Username

+

Optional username

username?: string

Your FTP Username

Memberof

FtpOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionhostidmaxConcurrentConnectionsmodifiedAtnamepassivepasswordporttransferVersiontypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionhostidmaxConcurrentConnectionsmodifiedAtnamepassivepasswordporttransferVersiontypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/GceAccount.html b/docs/classes/GceAccount.html index 0a66a216f..6ec6a3fef 100644 --- a/docs/classes/GceAccount.html +++ b/docs/classes/GceAccount.html @@ -1,5 +1,5 @@ GceAccount | @bitmovin/api-sdk

Class GceAccount

Export

GceAccount

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,22 +9,22 @@ privateKey? projectId? serviceAccountEmail? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional privateKey

privateKey?: string

Google private key of the Google service account that will be used to spin up VMs (required)

+

Optional privateKey

privateKey?: string

Google private key of the Google service account that will be used to spin up VMs (required)

Memberof

GceAccount

-

Optional projectId

projectId?: string

ID of the GCP project in which the VMs are supposed to run. (required)

+

Optional projectId

projectId?: string

ID of the GCP project in which the VMs are supposed to run. (required)

Memberof

GceAccount

-

Optional serviceAccountEmail

serviceAccountEmail?: string

Email address of the Google service account that will be used to spin up VMs (required)

+

Optional serviceAccountEmail

serviceAccountEmail?: string

Email address of the Google service account that will be used to spin up VMs (required)

Memberof

GceAccount

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameprivateKeyprojectIdserviceAccountEmail
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameprivateKeyprojectIdserviceAccountEmail
\ No newline at end of file diff --git a/docs/classes/GceAccountRegionSettings.html b/docs/classes/GceAccountRegionSettings.html index 0e967a27d..847858de4 100644 --- a/docs/classes/GceAccountRegionSettings.html +++ b/docs/classes/GceAccountRegionSettings.html @@ -1,5 +1,5 @@ GceAccountRegionSettings | @bitmovin/api-sdk

Class GceAccountRegionSettings

Export

GceAccountRegionSettings

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,21 +9,21 @@ network? region? subnetId? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional network

network?: string

Id of the network for encoding instances (required)

+

Optional network

network?: string

Id of the network for encoding instances (required)

Memberof

GceAccountRegionSettings

-

Optional region

region?: GoogleCloudRegion

Memberof

GceAccountRegionSettings

-

Optional subnetId

subnetId?: string

Id of the subnet for encoding instances (required)

+

Optional region

region?: GoogleCloudRegion

Memberof

GceAccountRegionSettings

+

Optional subnetId

subnetId?: string

Id of the subnet for encoding instances (required)

Memberof

GceAccountRegionSettings

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamenetworkregionsubnetId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamenetworkregionsubnetId
\ No newline at end of file diff --git a/docs/classes/GcsInput.html b/docs/classes/GcsInput.html index 1730fb56b..7abde012c 100644 --- a/docs/classes/GcsInput.html +++ b/docs/classes/GcsInput.html @@ -1,5 +1,5 @@ GcsInput | @bitmovin/api-sdk

Class GcsInput

Export

GcsInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? bucketName? cloudRegion? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

GCS access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

GCS access key (required)

Memberof

GcsInput

-

Optional bucketName

bucketName?: string

Name of the bucket (required)

+

Optional bucketName

bucketName?: string

Name of the bucket (required)

Memberof

GcsInput

-

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

+

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

Memberof

GcsInput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional secretKey

secretKey?: string

GCS secret key (required)

+

Optional secretKey

secretKey?: string

GCS secret key (required)

Memberof

GcsInput

-

Readonly type

type: InputType = InputType.GCS

Discriminator property for Input

+

Readonly type

type: InputType = InputType.GCS

Discriminator property for Input

Memberof

GcsInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeybucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnamesecretKeytype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeybucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnamesecretKeytype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/GcsOutput.html b/docs/classes/GcsOutput.html index 3f0d7101e..2dd137e97 100644 --- a/docs/classes/GcsOutput.html +++ b/docs/classes/GcsOutput.html @@ -1,5 +1,5 @@ GcsOutput | @bitmovin/api-sdk

Class GcsOutput

Export

GcsOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? acl? bucketName? @@ -14,28 +14,28 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

GCS access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

GCS access key (required)

Memberof

GcsOutput

-

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional bucketName

bucketName?: string

Name of the bucket (required)

+

Optional bucketName

bucketName?: string

Name of the bucket (required)

Memberof

GcsOutput

-

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

+

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

Memberof

GcsOutput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional secretKey

secretKey?: string

GCS secret key (required)

+

Optional secretKey

secretKey?: string

GCS secret key (required)

Memberof

GcsOutput

-

Readonly type

type: OutputType = OutputType.GCS

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.GCS

Discriminator property for Output

Memberof

GcsOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaclbucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnamesecretKeytype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaclbucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnamesecretKeytype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/GcsServiceAccountInput.html b/docs/classes/GcsServiceAccountInput.html index e82dae74f..9619a71bb 100644 --- a/docs/classes/GcsServiceAccountInput.html +++ b/docs/classes/GcsServiceAccountInput.html @@ -1,5 +1,5 @@ GcsServiceAccountInput | @bitmovin/api-sdk

Class GcsServiceAccountInput

Export

GcsServiceAccountInput

-

Hierarchy (view full)

  • Input
    • GcsServiceAccountInput

Constructors

constructor +

Hierarchy (view full)

  • Input
    • GcsServiceAccountInput

Constructors

constructor

Properties

bucketName? cloudRegion? createdAt? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bucketName

bucketName?: string

Name of the bucket (required)

+

Constructors

constructor

Properties

Optional bucketName

bucketName?: string

Name of the bucket (required)

Memberof

GcsServiceAccountInput

-

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

+

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

Memberof

GcsServiceAccountInput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional serviceAccountCredentials

serviceAccountCredentials?: string

GCS projectId (required)

+

Optional serviceAccountCredentials

serviceAccountCredentials?: string

GCS projectId (required)

Memberof

GcsServiceAccountInput

-

Readonly type

type: InputType = InputType.GCS_SERVICE_ACCOUNT

Discriminator property for Input

+

Readonly type

type: InputType = InputType.GCS_SERVICE_ACCOUNT

Discriminator property for Input

Memberof

GcsServiceAccountInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnameserviceAccountCredentialstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnameserviceAccountCredentialstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/GcsServiceAccountOutput.html b/docs/classes/GcsServiceAccountOutput.html index 22ea53a14..1a6fa9541 100644 --- a/docs/classes/GcsServiceAccountOutput.html +++ b/docs/classes/GcsServiceAccountOutput.html @@ -1,5 +1,5 @@ GcsServiceAccountOutput | @bitmovin/api-sdk

Class GcsServiceAccountOutput

Export

GcsServiceAccountOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? bucketName? cloudRegion? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional bucketName

bucketName?: string

Name of the bucket (required)

+

Optional bucketName

bucketName?: string

Name of the bucket (required)

Memberof

GcsServiceAccountOutput

-

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

+

Optional cloudRegion

cloudRegion?: GoogleCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

Memberof

GcsServiceAccountOutput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional serviceAccountCredentials

serviceAccountCredentials?: string

GCS projectId (required)

+

Optional serviceAccountCredentials

serviceAccountCredentials?: string

GCS projectId (required)

Memberof

GcsServiceAccountOutput

-

Readonly type

type: OutputType = OutputType.GCS_SERVICE_ACCOUNT

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.GCS_SERVICE_ACCOUNT

Discriminator property for Output

Memberof

GcsServiceAccountOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclbucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnameserviceAccountCredentialstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclbucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnameserviceAccountCredentialstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/GenericS3Input.html b/docs/classes/GenericS3Input.html index ddc3c42c9..c54bd7584 100644 --- a/docs/classes/GenericS3Input.html +++ b/docs/classes/GenericS3Input.html @@ -1,5 +1,5 @@ GenericS3Input | @bitmovin/api-sdk

Class GenericS3Input

Export

GenericS3Input

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? accessStyle? bucketName? @@ -18,36 +18,36 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Your generic S3 access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Your generic S3 access key (required)

Memberof

GenericS3Input

-

Optional accessStyle

accessStyle?: S3AccessStyle

Specifies the URL access style to use

+

Optional accessStyle

accessStyle?: S3AccessStyle

Specifies the URL access style to use

Memberof

GenericS3Input

-

Optional bucketName

bucketName?: string

Your generic S3 bucket name (required)

+

Optional bucketName

bucketName?: string

Your generic S3 bucket name (required)

Memberof

GenericS3Input

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

The generic S3 server hostname (or IP address) (required)

+

Optional host

host?: string

The generic S3 server hostname (or IP address) (required)

Memberof

GenericS3Input

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional port

port?: number

The port on which the generic S3 server is running on (if not provided 8000 will be used)

+

Optional port

port?: number

The port on which the generic S3 server is running on (if not provided 8000 will be used)

Memberof

GenericS3Input

-

Optional secretKey

secretKey?: string

Your generic S3 secret key (required)

+

Optional secretKey

secretKey?: string

Your generic S3 secret key (required)

Memberof

GenericS3Input

-

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication

+

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication

Memberof

GenericS3Input

-

Optional signingRegion

signingRegion?: string

The signing region to use

+

Optional signingRegion

signingRegion?: string

The signing region to use

Memberof

GenericS3Input

-

Optional ssl

ssl?: boolean

Controls whether SSL is used or not

+

Optional ssl

ssl?: boolean

Controls whether SSL is used or not

Memberof

GenericS3Input

-

Readonly type

type: InputType = InputType.GENERIC_S3

Discriminator property for Input

+

Readonly type

type: InputType = InputType.GENERIC_S3

Discriminator property for Input

Memberof

GenericS3Input

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaccessStylebucketNamecreatedAtcustomDatadescriptionhostidmodifiedAtnameportsecretKeysignatureVersionsigningRegionssltype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaccessStylebucketNamecreatedAtcustomDatadescriptionhostidmodifiedAtnameportsecretKeysignatureVersionsigningRegionssltype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/GenericS3Output.html b/docs/classes/GenericS3Output.html index e965e59a1..2a0ce2fb0 100644 --- a/docs/classes/GenericS3Output.html +++ b/docs/classes/GenericS3Output.html @@ -1,5 +1,5 @@ GenericS3Output | @bitmovin/api-sdk

Class GenericS3Output

Export

GenericS3Output

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? accessStyle? acl? @@ -19,38 +19,38 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Your generic S3 access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Your generic S3 access key (required)

Memberof

GenericS3Output

-

Optional accessStyle

accessStyle?: S3AccessStyle

Specifies the URL access style to use

+

Optional accessStyle

accessStyle?: S3AccessStyle

Specifies the URL access style to use

Memberof

GenericS3Output

-

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional bucketName

bucketName?: string

Name of the bucket (required)

+

Optional bucketName

bucketName?: string

Name of the bucket (required)

Memberof

GenericS3Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

The Generic S3 server hostname (or IP address) (required)

+

Optional host

host?: string

The Generic S3 server hostname (or IP address) (required)

Memberof

GenericS3Output

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional port

port?: number

The port on which the Generic S3 server is running on (if not provided 8000 will be used)

+

Optional port

port?: number

The port on which the Generic S3 server is running on (if not provided 8000 will be used)

Memberof

GenericS3Output

-

Optional secretKey

secretKey?: string

Your generic S3 secret key (required)

+

Optional secretKey

secretKey?: string

Your generic S3 secret key (required)

Memberof

GenericS3Output

-

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication

+

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication

Memberof

GenericS3Output

-

Optional signingRegion

signingRegion?: string

The signing region to use

+

Optional signingRegion

signingRegion?: string

The signing region to use

Memberof

GenericS3Output

-

Optional ssl

ssl?: boolean

Controls whether SSL is used or not

+

Optional ssl

ssl?: boolean

Controls whether SSL is used or not

Memberof

GenericS3Output

-

Readonly type

type: OutputType = OutputType.GENERIC_S3

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.GENERIC_S3

Discriminator property for Output

Memberof

GenericS3Output

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaccessStyleaclbucketNamecreatedAtcustomDatadescriptionhostidmodifiedAtnameportsecretKeysignatureVersionsigningRegionssltype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaccessStyleaclbucketNamecreatedAtcustomDatadescriptionhostidmodifiedAtnameportsecretKeysignatureVersionsigningRegionssltype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Group.html b/docs/classes/Group.html index 0738fed6a..decddd68c 100644 --- a/docs/classes/Group.html +++ b/docs/classes/Group.html @@ -1,21 +1,21 @@ Group | @bitmovin/api-sdk

Class Group

Export

Group

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? id? modifiedAt? name? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname
\ No newline at end of file diff --git a/docs/classes/H262VideoConfiguration.html b/docs/classes/H262VideoConfiguration.html index 22fb2d36f..c15adbbae 100644 --- a/docs/classes/H262VideoConfiguration.html +++ b/docs/classes/H262VideoConfiguration.html @@ -1,5 +1,5 @@ H262VideoConfiguration | @bitmovin/api-sdk

Class H262VideoConfiguration

Export

H262VideoConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bframes? bitrate? bufsize? @@ -28,55 +28,55 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bframes

bframes?: number

Amount of b frames.

+

Constructors

constructor

Properties

Optional bframes

bframes?: number

Amount of b frames.

Memberof

H262VideoConfiguration

-

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

+

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Memberof

VideoConfiguration

-

Optional bufsize

bufsize?: number

Playback device buffer size

+

Optional bufsize

bufsize?: number

Playback device buffer size

Memberof

H262VideoConfiguration

-

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

+

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Memberof

VideoConfiguration

-

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

+

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

Memberof

VideoConfiguration

-

Optional gopSize

gopSize?: number

Minimum GOP length, the minimum distance between I-frames

+

Optional gopSize

gopSize?: number

Minimum GOP length, the minimum distance between I-frames

Memberof

H262VideoConfiguration

-

Optional height

height?: number

Height of the encoded video in pixels

+

Optional height

height?: number

Height of the encoded video in pixels

Memberof

VideoConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional interlaceMode

interlaceMode?: H262InterlaceMode

Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video

+

Optional interlaceMode

interlaceMode?: H262InterlaceMode

Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video

Memberof

H262VideoConfiguration

-

Optional level

level?: LevelH262

Specified set of constraints that indicate a degree of required decoder performance for a profile

+

Optional level

level?: LevelH262

Specified set of constraints that indicate a degree of required decoder performance for a profile

Memberof

H262VideoConfiguration

-

Optional maxBitrate

maxBitrate?: number

Maximum Bitrate

+

Optional maxBitrate

maxBitrate?: number

Maximum Bitrate

Memberof

H262VideoConfiguration

-

Optional minBitrate

minBitrate?: number

Minimum Bitrate

+

Optional minBitrate

minBitrate?: number

Minimum Bitrate

Memberof

H262VideoConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

+

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Memberof

VideoConfiguration

-

Optional presetConfiguration

presetConfiguration?: XDCAM_HD_422

Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.

+

Optional presetConfiguration

presetConfiguration?: XDCAM_HD_422

Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.

Memberof

H262VideoConfiguration

-

Optional profile

profile?: MPEG2_422

When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen. (required)

+

Optional profile

profile?: MPEG2_422

When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen. (required)

Memberof

H262VideoConfiguration

-

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

+

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

Memberof

VideoConfiguration

-

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.H262

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.H262

Discriminator property for CodecConfiguration

Memberof

H262VideoConfiguration

-

Optional width

width?: number

Width of the encoded video in pixels

+

Optional width

width?: number

Width of the encoded video in pixels

Memberof

VideoConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbframesbitratebufsizecolorConfigcreatedAtcustomDatadescriptiondisplayAspectRatioencodingModegopSizeheightidinterlaceModelevelmaxBitrateminBitratemodifiedAtnamepixelFormatpresetConfigurationprofileratesampleAspectRatioDenominatorsampleAspectRatioNumeratortypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbframesbitratebufsizecolorConfigcreatedAtcustomDatadescriptiondisplayAspectRatioencodingModegopSizeheightidinterlaceModelevelmaxBitrateminBitratemodifiedAtnamepixelFormatpresetConfigurationprofileratesampleAspectRatioDenominatorsampleAspectRatioNumeratortypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/H264PerTitleConfiguration.html b/docs/classes/H264PerTitleConfiguration.html index f72255cae..add8befe6 100644 --- a/docs/classes/H264PerTitleConfiguration.html +++ b/docs/classes/H264PerTitleConfiguration.html @@ -1,5 +1,5 @@ H264PerTitleConfiguration | @bitmovin/api-sdk

Class H264PerTitleConfiguration

Export

H264PerTitleConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoRepresentations? codecBufsizeFactor? codecMaxBitrateFactor? @@ -11,25 +11,25 @@ minBitrate? minBitrateStepSize? targetQualityCrf? -

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

-

Optional codecBufsizeFactor

codecBufsizeFactor?: number

This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate

+

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

+

Optional codecBufsizeFactor

codecBufsizeFactor?: number

This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate

Memberof

H264PerTitleConfiguration

-

Optional codecMaxBitrateFactor

codecMaxBitrateFactor?: number

This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate

+

Optional codecMaxBitrateFactor

codecMaxBitrateFactor?: number

This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate

Memberof

H264PerTitleConfiguration

-

Optional codecMinBitrateFactor

codecMinBitrateFactor?: number

This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate

+

Optional codecMinBitrateFactor

codecMinBitrateFactor?: number

This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate

Memberof

H264PerTitleConfiguration

-

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

+

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

Memberof

PerTitleConfiguration

-

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

+

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

Memberof

PerTitleConfiguration

-

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

+

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

Memberof

PerTitleConfiguration

-

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

+

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

Memberof

PerTitleConfiguration

-

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

+

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

Memberof

PerTitleConfiguration

-

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

+

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

Memberof

PerTitleConfiguration

-

Optional targetQualityCrf

targetQualityCrf?: number

Desired target quality of the highest representation expressed as CRF value

+

Optional targetQualityCrf

targetQualityCrf?: number

Desired target quality of the highest representation expressed as CRF value

Memberof

H264PerTitleConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscodecBufsizeFactorcodecMaxBitrateFactorcodecMinBitrateFactorcomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSizetargetQualityCrf
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscodecBufsizeFactorcodecMaxBitrateFactorcodecMinBitrateFactorcomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSizetargetQualityCrf
\ No newline at end of file diff --git a/docs/classes/H264PictureTimingTrimmingInputStream.html b/docs/classes/H264PictureTimingTrimmingInputStream.html index 248f59840..bce8cbf16 100644 --- a/docs/classes/H264PictureTimingTrimmingInputStream.html +++ b/docs/classes/H264PictureTimingTrimmingInputStream.html @@ -1,5 +1,5 @@ H264PictureTimingTrimmingInputStream | @bitmovin/api-sdk

Class H264PictureTimingTrimmingInputStream

Export

H264PictureTimingTrimmingInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional endPicTiming

endPicTiming?: string

Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding

+

Optional endPicTiming

endPicTiming?: string

Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding

Memberof

H264PictureTimingTrimmingInputStream

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputStreamId

inputStreamId?: string

The id of the ingest input stream that should be trimmed

+

Optional inputStreamId

inputStreamId?: string

The id of the ingest input stream that should be trimmed

Memberof

H264PictureTimingTrimmingInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional startPicTiming

startPicTiming?: string

Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding

+

Optional startPicTiming

startPicTiming?: string

Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding

Memberof

H264PictureTimingTrimmingInputStream

-

Readonly type

type: InputStreamType = InputStreamType.TRIMMING_H264_PICTURE_TIMING

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.TRIMMING_H264_PICTURE_TIMING

Discriminator property for InputStream

Memberof

H264PictureTimingTrimmingInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionendPicTimingidinputStreamIdmodifiedAtnamestartPicTimingtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionendPicTimingidinputStreamIdmodifiedAtnamestartPicTimingtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/H264VideoConfiguration.html b/docs/classes/H264VideoConfiguration.html index e3805ff0c..40c575e3b 100644 --- a/docs/classes/H264VideoConfiguration.html +++ b/docs/classes/H264VideoConfiguration.html @@ -1,5 +1,5 @@ H264VideoConfiguration | @bitmovin/api-sdk

Class H264VideoConfiguration

Export

H264VideoConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

adaptiveQuantizationMode? adaptiveQuantizationStrength? adaptiveSpatialTransform? @@ -65,126 +65,126 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional adaptiveQuantizationMode

adaptiveQuantizationMode?: AdaptiveQuantMode

Controls the adaptive quantization algorithm

+

Constructors

constructor

Properties

Optional adaptiveQuantizationMode

adaptiveQuantizationMode?: AdaptiveQuantMode

Controls the adaptive quantization algorithm

Memberof

H264VideoConfiguration

-

Optional adaptiveQuantizationStrength

adaptiveQuantizationStrength?: number

Values greater than 1 reduce blocking and blurring in flat and textured areas. Values less than 1 reduces ringing artifacts at the cost of more banding artifacts. Negative values are not allowed

+

Optional adaptiveQuantizationStrength

adaptiveQuantizationStrength?: number

Values greater than 1 reduce blocking and blurring in flat and textured areas. Values less than 1 reduces ringing artifacts at the cost of more banding artifacts. Negative values are not allowed

Memberof

H264VideoConfiguration

-

Optional adaptiveSpatialTransform

adaptiveSpatialTransform?: boolean

Enables adaptive spatial transform (high profile 8x8 transform)

+

Optional adaptiveSpatialTransform

adaptiveSpatialTransform?: boolean

Enables adaptive spatial transform (high profile 8x8 transform)

Memberof

H264VideoConfiguration

-

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.

+

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.

Memberof

H264VideoConfiguration

-

Optional bAdaptiveStrategy

bAdaptiveStrategy?: BAdapt

Memberof

H264VideoConfiguration

-

Optional bPyramid

bPyramid?: H264BPyramid

Keep some B-frames as references

+

Optional bAdaptiveStrategy

bAdaptiveStrategy?: BAdapt

Memberof

H264VideoConfiguration

+

Optional bPyramid

bPyramid?: H264BPyramid

Keep some B-frames as references

Memberof

H264VideoConfiguration

-

Optional bframes

bframes?: number

Amount of b frames

+

Optional bframes

bframes?: number

Amount of b frames

Memberof

H264VideoConfiguration

-

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

+

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Memberof

VideoConfiguration

-

Optional bufsize

bufsize?: number

Playback device buffer size

+

Optional bufsize

bufsize?: number

Playback device buffer size

Memberof

H264VideoConfiguration

-

Optional cabac

cabac?: boolean

Enable or disable CABAC

+

Optional cabac

cabac?: boolean

Enable or disable CABAC

Memberof

H264VideoConfiguration

-

Optional cea608708SubtitleConfig

cea608708SubtitleConfig?: Cea608708SubtitleConfiguration

Defines whether CEA 608/708 subtitles are copied from the input video stream

+

Optional cea608708SubtitleConfig

cea608708SubtitleConfig?: Cea608708SubtitleConfiguration

Defines whether CEA 608/708 subtitles are copied from the input video stream

Memberof

H264VideoConfiguration

-

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

+

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

Memberof

H264VideoConfiguration

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional deblockAlpha

deblockAlpha?: number

Strength of the in-loop deblocking filter. Higher values deblock more effectively but also soften the image

+

Optional deblockAlpha

deblockAlpha?: number

Strength of the in-loop deblocking filter. Higher values deblock more effectively but also soften the image

Memberof

H264VideoConfiguration

-

Optional deblockBeta

deblockBeta?: number

Threshold of the in-loop deblocking filter. Higher values apply deblocking stronger on non flat blocks, lower values on flat blocks

+

Optional deblockBeta

deblockBeta?: number

Threshold of the in-loop deblocking filter. Higher values apply deblocking stronger on non flat blocks, lower values on flat blocks

Memberof

H264VideoConfiguration

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

+

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Memberof

VideoConfiguration

-

Optional dynamicRangeFormat

dynamicRangeFormat?: SDR

Automatically configures the H264 Video Codec to be compatible with the given SDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.

+

Optional dynamicRangeFormat

dynamicRangeFormat?: SDR

Automatically configures the H264 Video Codec to be compatible with the given SDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.

Memberof

H264VideoConfiguration

-

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

+

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

Memberof

VideoConfiguration

-

Optional fastSkipDetectionPFrames

fastSkipDetectionPFrames?: boolean

Enables fast skip detection on P-frames. Disabling this very slightly increases quality but at a large speed loss

+

Optional fastSkipDetectionPFrames

fastSkipDetectionPFrames?: boolean

Enables fast skip detection on P-frames. Disabling this very slightly increases quality but at a large speed loss

Memberof

H264VideoConfiguration

-

Optional height

height?: number

Height of the encoded video in pixels

+

Optional height

height?: number

Height of the encoded video in pixels

Memberof

VideoConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional interlaceMode

interlaceMode?: H264InterlaceMode

Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video

+

Optional interlaceMode

interlaceMode?: H264InterlaceMode

Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video

Memberof

H264VideoConfiguration

-

Optional level

level?: LevelH264

If three-pass encoding is used and a level is set for the encoder, the bitrate for some segments may exceed the bitrate limit which is defined by the level.

+

Optional level

level?: LevelH264

If three-pass encoding is used and a level is set for the encoder, the bitrate for some segments may exceed the bitrate limit which is defined by the level.

Memberof

H264VideoConfiguration

-

Optional macroblockTreeRatecontrol

macroblockTreeRatecontrol?: boolean

Enable macroblock tree ratecontrol. Macroblock tree rate control tracks how often blocks of the frame are used for prediciting future frames

+

Optional macroblockTreeRatecontrol

macroblockTreeRatecontrol?: boolean

Enable macroblock tree ratecontrol. Macroblock tree rate control tracks how often blocks of the frame are used for prediciting future frames

Memberof

H264VideoConfiguration

-

Optional maxBitrate

maxBitrate?: number

Maximum Bitrate

+

Optional maxBitrate

maxBitrate?: number

Maximum Bitrate

Memberof

H264VideoConfiguration

-

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

+

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

Memberof

H264VideoConfiguration

-

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

+

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

Memberof

H264VideoConfiguration

-

Optional minBitrate

minBitrate?: number

Minimum Bitrate

+

Optional minBitrate

minBitrate?: number

Minimum Bitrate

Memberof

H264VideoConfiguration

-

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames

+

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames

Memberof

H264VideoConfiguration

-

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

+

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

Memberof

H264VideoConfiguration

-

Optional mixedReferences

mixedReferences?: boolean

Allow references on a per partition basis, rather than per-macroblock basis

+

Optional mixedReferences

mixedReferences?: boolean

Allow references on a per partition basis, rather than per-macroblock basis

Memberof

H264VideoConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional motionEstimationMethod

motionEstimationMethod?: H264MotionEstimationMethod

Memberof

H264VideoConfiguration

-

Optional mvPredictionMode

mvPredictionMode?: MvPredictionMode

Memberof

H264VideoConfiguration

-

Optional mvSearchRangeMax

mvSearchRangeMax?: number

Maximum motion vector search range

+

Optional motionEstimationMethod

motionEstimationMethod?: H264MotionEstimationMethod

Memberof

H264VideoConfiguration

+

Optional mvPredictionMode

mvPredictionMode?: MvPredictionMode

Memberof

H264VideoConfiguration

+

Optional mvSearchRangeMax

mvSearchRangeMax?: number

Maximum motion vector search range

Memberof

H264VideoConfiguration

-

Optional nalHrd

nalHrd?: H264NalHrd

Signal hypothetical reference decoder (HRD) information (requires bufsize to be set)

+

Optional nalHrd

nalHrd?: H264NalHrd

Signal hypothetical reference decoder (HRD) information (requires bufsize to be set)

Memberof

H264VideoConfiguration

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional openGop

openGop?: boolean

Enable open-gop, allows referencing frames from a previous gop

+

Optional openGop

openGop?: boolean

Enable open-gop, allows referencing frames from a previous gop

Memberof

H264VideoConfiguration

-

Optional partitions

partitions?: H264Partition[]

Partitions to consider. Analyzing more partition options improves quality at the cost of speed.

+

Optional partitions

partitions?: H264Partition[]

Partitions to consider. Analyzing more partition options improves quality at the cost of speed.

Memberof

H264VideoConfiguration

-

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

+

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Memberof

VideoConfiguration

-

Optional presetConfiguration

presetConfiguration?: PresetConfiguration

Choose from a set of preset configurations tailored for common use cases. Check out H264 Presets to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.

+

Optional presetConfiguration

presetConfiguration?: PresetConfiguration

Choose from a set of preset configurations tailored for common use cases. Check out H264 Presets to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.

Memberof

H264VideoConfiguration

-

Optional profile

profile?: ProfileH264

When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen. (required)

+

Optional profile

profile?: ProfileH264

When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen. (required)

Memberof

H264VideoConfiguration

-

Optional psyRateDistortionOptimization

psyRateDistortionOptimization?: number

Psychovisual Rate Distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP or RD_REF_ALL

+

Optional psyRateDistortionOptimization

psyRateDistortionOptimization?: number

Psychovisual Rate Distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP or RD_REF_ALL

Memberof

H264VideoConfiguration

-

Optional psyTrellis

psyTrellis?: number

Higher values will improve sharpness and detail retention but might come at costs of artifacts. Needs to have trellis enabled

+

Optional psyTrellis

psyTrellis?: number

Higher values will improve sharpness and detail retention but might come at costs of artifacts. Needs to have trellis enabled

Memberof

H264VideoConfiguration

-

Optional qpMax

qpMax?: number

Maximum quantization factor

+

Optional qpMax

qpMax?: number

Maximum quantization factor

Memberof

H264VideoConfiguration

-

Optional qpMin

qpMin?: number

Minimum quantization factor

+

Optional qpMin

qpMin?: number

Minimum quantization factor

Memberof

H264VideoConfiguration

-

Optional quantizerCurveCompression

quantizerCurveCompression?: number

Ratio between constant bitrate (0.0) and constant quantizer (1.0). Valid range 0.0 - 1.0

+

Optional quantizerCurveCompression

quantizerCurveCompression?: number

Ratio between constant bitrate (0.0) and constant quantizer (1.0). Valid range 0.0 - 1.0

Memberof

H264VideoConfiguration

-

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

+

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

Memberof

VideoConfiguration

-

Optional rcLookahead

rcLookahead?: number

Number of frames for frame-type decision lookahead

+

Optional rcLookahead

rcLookahead?: number

Number of frames for frame-type decision lookahead

Memberof

H264VideoConfiguration

-

Optional refFrames

refFrames?: number

Amount of reference frames.

+

Optional refFrames

refFrames?: number

Amount of reference frames.

Memberof

H264VideoConfiguration

-

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sceneCutThreshold

sceneCutThreshold?: number

Scene change sensitivity. The higher the value, the more likely an I-frame will be inserted. Set to 0 to disable it which is advised for scenarios where fixed GOP is required, e.g., adaptive streaming outputs like DASH, HLS and Smooth. Having this setting enabled can improve quality for progressive output with an increased internal chunk length (see internalChunkLength of muxings).

+

Optional sceneCutThreshold

sceneCutThreshold?: number

Scene change sensitivity. The higher the value, the more likely an I-frame will be inserted. Set to 0 to disable it which is advised for scenarios where fixed GOP is required, e.g., adaptive streaming outputs like DASH, HLS and Smooth. Having this setting enabled can improve quality for progressive output with an increased internal chunk length (see internalChunkLength of muxings).

Memberof

H264VideoConfiguration

-

Optional slices

slices?: number

Number of slices per frame.

+

Optional slices

slices?: number

Number of slices per frame.

Memberof

H264VideoConfiguration

-

Optional subMe

subMe?: H264SubMe

Subpixel motion estimation and mode decision

+

Optional subMe

subMe?: H264SubMe

Subpixel motion estimation and mode decision

Memberof

H264VideoConfiguration

-

Optional trellis

trellis?: H264Trellis

Enables or disables Trellis quantization. NOTE: This requires cabac

+

Optional trellis

trellis?: H264Trellis

Enables or disables Trellis quantization. NOTE: This requires cabac

Memberof

H264VideoConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.H264

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.H264

Discriminator property for CodecConfiguration

Memberof

H264VideoConfiguration

-

Optional weightedPredictionBFrames

weightedPredictionBFrames?: boolean

Enable open-gop, allows referencing frames from a previous gop

+

Optional weightedPredictionBFrames

weightedPredictionBFrames?: boolean

Enable open-gop, allows referencing frames from a previous gop

Memberof

H264VideoConfiguration

-

Optional weightedPredictionPFrames

weightedPredictionPFrames?: WeightedPredictionPFrames

Defines the mode for weighted prediction for P-frames

+

Optional weightedPredictionPFrames

weightedPredictionPFrames?: WeightedPredictionPFrames

Defines the mode for weighted prediction for P-frames

Memberof

H264VideoConfiguration

-

Optional width

width?: number

Width of the encoded video in pixels

+

Optional width

width?: number

Width of the encoded video in pixels

Memberof

VideoConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradaptiveQuantizationModeadaptiveQuantizationStrengthadaptiveSpatialTransformautoLevelSetupbAdaptiveStrategybPyramidbframesbitratebufsizecabaccea608708SubtitleConfigcolorConfigcreatedAtcrfcustomDatadeblockAlphadeblockBetadescriptiondisplayAspectRatiodynamicRangeFormatencodingModefastSkipDetectionPFramesheightidinterlaceModelevelmacroblockTreeRatecontrolmaxBitratemaxGopmaxKeyframeIntervalminBitrateminGopminKeyframeIntervalmixedReferencesmodifiedAtmotionEstimationMethodmvPredictionModemvSearchRangeMaxnalHrdnameopenGoppartitionspixelFormatpresetConfigurationprofilepsyRateDistortionOptimizationpsyTrellisqpMaxqpMinquantizerCurveCompressionratercLookaheadrefFramessampleAspectRatioDenominatorsampleAspectRatioNumeratorsceneCutThresholdslicessubMetrellistypeweightedPredictionBFramesweightedPredictionPFrameswidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradaptiveQuantizationModeadaptiveQuantizationStrengthadaptiveSpatialTransformautoLevelSetupbAdaptiveStrategybPyramidbframesbitratebufsizecabaccea608708SubtitleConfigcolorConfigcreatedAtcrfcustomDatadeblockAlphadeblockBetadescriptiondisplayAspectRatiodynamicRangeFormatencodingModefastSkipDetectionPFramesheightidinterlaceModelevelmacroblockTreeRatecontrolmaxBitratemaxGopmaxKeyframeIntervalminBitrateminGopminKeyframeIntervalmixedReferencesmodifiedAtmotionEstimationMethodmvPredictionModemvSearchRangeMaxnalHrdnameopenGoppartitionspixelFormatpresetConfigurationprofilepsyRateDistortionOptimizationpsyTrellisqpMaxqpMinquantizerCurveCompressionratercLookaheadrefFramessampleAspectRatioDenominatorsampleAspectRatioNumeratorsceneCutThresholdslicessubMetrellistypeweightedPredictionBFramesweightedPredictionPFrameswidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/H265PerTitleConfiguration.html b/docs/classes/H265PerTitleConfiguration.html index 95c431169..fd8ac68d9 100644 --- a/docs/classes/H265PerTitleConfiguration.html +++ b/docs/classes/H265PerTitleConfiguration.html @@ -1,5 +1,5 @@ H265PerTitleConfiguration | @bitmovin/api-sdk

Class H265PerTitleConfiguration

Export

H265PerTitleConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoRepresentations? codecBufsizeFactor? codecMaxBitrateFactor? @@ -11,25 +11,25 @@ minBitrate? minBitrateStepSize? targetQualityCrf? -

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

-

Optional codecBufsizeFactor

codecBufsizeFactor?: number

This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate

+

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

+

Optional codecBufsizeFactor

codecBufsizeFactor?: number

This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate

Memberof

H265PerTitleConfiguration

-

Optional codecMaxBitrateFactor

codecMaxBitrateFactor?: number

This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate

+

Optional codecMaxBitrateFactor

codecMaxBitrateFactor?: number

This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate

Memberof

H265PerTitleConfiguration

-

Optional codecMinBitrateFactor

codecMinBitrateFactor?: number

This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate

+

Optional codecMinBitrateFactor

codecMinBitrateFactor?: number

This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate

Memberof

H265PerTitleConfiguration

-

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

+

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

Memberof

PerTitleConfiguration

-

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

+

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

Memberof

PerTitleConfiguration

-

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

+

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

Memberof

PerTitleConfiguration

-

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

+

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

Memberof

PerTitleConfiguration

-

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

+

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

Memberof

PerTitleConfiguration

-

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

+

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

Memberof

PerTitleConfiguration

-

Optional targetQualityCrf

targetQualityCrf?: number

Desired target quality of the highest representation expressed as CRF value

+

Optional targetQualityCrf

targetQualityCrf?: number

Desired target quality of the highest representation expressed as CRF value

Memberof

H265PerTitleConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscodecBufsizeFactorcodecMaxBitrateFactorcodecMinBitrateFactorcomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSizetargetQualityCrf
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscodecBufsizeFactorcodecMaxBitrateFactorcodecMinBitrateFactorcomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSizetargetQualityCrf
\ No newline at end of file diff --git a/docs/classes/H265VideoConfiguration.html b/docs/classes/H265VideoConfiguration.html index 65d6f341d..5f9474243 100644 --- a/docs/classes/H265VideoConfiguration.html +++ b/docs/classes/H265VideoConfiguration.html @@ -1,5 +1,5 @@ H265VideoConfiguration | @bitmovin/api-sdk

Class H265VideoConfiguration

Export

H265VideoConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

adaptiveQuantizationMode? adaptiveQuantizationMotion? adaptiveQuantizationStrength? @@ -116,225 +116,225 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional adaptiveQuantizationMode

adaptiveQuantizationMode?: AdaptiveQuantMode

Controls the adaptive quantization algorithm

+

Constructors

constructor

Properties

Optional adaptiveQuantizationMode

adaptiveQuantizationMode?: AdaptiveQuantMode

Controls the adaptive quantization algorithm

Memberof

H265VideoConfiguration

-

Optional adaptiveQuantizationMotion

adaptiveQuantizationMotion?: boolean

Adjust the AQ offsets based on the relative motion of each block with respect to the motion of the frame. Default false.

+

Optional adaptiveQuantizationMotion

adaptiveQuantizationMotion?: boolean

Adjust the AQ offsets based on the relative motion of each block with respect to the motion of the frame. Default false.

Memberof

H265VideoConfiguration

-

Optional adaptiveQuantizationStrength

adaptiveQuantizationStrength?: number

Adjust the strength of the adaptive quantization offsets. Default 1.0.

+

Optional adaptiveQuantizationStrength

adaptiveQuantizationStrength?: number

Adjust the strength of the adaptive quantization offsets. Default 1.0.

Memberof

H265VideoConfiguration

-

Optional allowedRADLBeforeIDR

allowedRADLBeforeIDR?: number

Number of RADL pictures allowed infront of IDR. Requires fixed keyframe interval. Valid values 0 - bframes. Default 0.

+

Optional allowedRADLBeforeIDR

allowedRADLBeforeIDR?: number

Number of RADL pictures allowed infront of IDR. Requires fixed keyframe interval. Valid values 0 - bframes. Default 0.

Memberof

H265VideoConfiguration

-

Optional analyzeSourceFramePixels

analyzeSourceFramePixels?: boolean

Enable motion estimation with source frame pixels, in this mode, motion estimation can be computed independently. Default false.

+

Optional analyzeSourceFramePixels

analyzeSourceFramePixels?: boolean

Enable motion estimation with source frame pixels, in this mode, motion estimation can be computed independently. Default false.

Memberof

H265VideoConfiguration

-

Optional asymetricMotionPartitionsAnalysis

asymetricMotionPartitionsAnalysis?: boolean

Enable analysis of asymmetric motion partitions.

+

Optional asymetricMotionPartitionsAnalysis

asymetricMotionPartitionsAnalysis?: boolean

Enable analysis of asymmetric motion partitions.

Memberof

H265VideoConfiguration

-

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.

+

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.

Memberof

H265VideoConfiguration

-

Optional bAdapt

bAdapt?: BAdapt

Set the level of effort in determining B frame placement

+

Optional bAdapt

bAdapt?: BAdapt

Set the level of effort in determining B frame placement

Memberof

H265VideoConfiguration

-

Optional bframeBias

bframeBias?: number

Bias towards B frames in slicetype decision. The higher the bias the more likely the encoder is to use B frames. Default 0

+

Optional bframeBias

bframeBias?: number

Bias towards B frames in slicetype decision. The higher the bias the more likely the encoder is to use B frames. Default 0

Memberof

H265VideoConfiguration

-

Optional bframes

bframes?: number

Amount of b frames

+

Optional bframes

bframes?: number

Amount of b frames

Memberof

H265VideoConfiguration

-

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

+

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Memberof

VideoConfiguration

-

Optional blurComplexity

blurComplexity?: number

Temporally blur complexity. Default 20.0

+

Optional blurComplexity

blurComplexity?: number

Temporally blur complexity. Default 20.0

Memberof

H265VideoConfiguration

-

Optional blurQuants

blurQuants?: number

Temporally blur quants. Default 0.5

+

Optional blurQuants

blurQuants?: number

Temporally blur quants. Default 0.5

Memberof

H265VideoConfiguration

-

Optional bufsize

bufsize?: number

Size of the VBV buffer (kbits)

+

Optional bufsize

bufsize?: number

Size of the VBV buffer (kbits)

Memberof

H265VideoConfiguration

-

Optional cea608708SubtitleConfig

cea608708SubtitleConfig?: Cea608708SubtitleConfiguration

Defines whether CEA 608/708 subtitles are extracted from the input video stream

+

Optional cea608708SubtitleConfig

cea608708SubtitleConfig?: Cea608708SubtitleConfiguration

Defines whether CEA 608/708 subtitles are extracted from the input video stream

Memberof

H265VideoConfiguration

-

Optional codingUnitLossless

codingUnitLossless?: boolean

If enabled, consider lossless mode in CU RDO decisions. Default is disabled.

+

Optional codingUnitLossless

codingUnitLossless?: boolean

If enabled, consider lossless mode in CU RDO decisions. Default is disabled.

Memberof

H265VideoConfiguration

-

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

-

Optional constrainedIntraPrediction

constrainedIntraPrediction?: boolean

When generating intra predictions for blocks in inter slices, only intra-coded reference pixels are used. Default false.

+

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

+

Optional constrainedIntraPrediction

constrainedIntraPrediction?: boolean

When generating intra predictions for blocks in inter slices, only intra-coded reference pixels are used. Default false.

Memberof

H265VideoConfiguration

-

Optional copyPicture

copyPicture?: boolean

Copy buffers of input picture in frame. Default is enabled.

+

Optional copyPicture

copyPicture?: boolean

Copy buffers of input picture in frame. Default is enabled.

Memberof

H265VideoConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

+

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

Memberof

H265VideoConfiguration

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional cutree

cutree?: boolean

Enables the use of lookahead’s lowres motion vector fields to determine the amount of reuse of each block to tune adaptive quantization factors.

+

Optional cutree

cutree?: boolean

Enables the use of lookahead’s lowres motion vector fields to determine the amount of reuse of each block to tune adaptive quantization factors.

Memberof

H265VideoConfiguration

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

+

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Memberof

VideoConfiguration

-

Optional dynamicRangeFormat

dynamicRangeFormat?: H265DynamicRangeFormat

Automatically configures the H265 Video Codec to be compatible with the given SDR/HDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.

+

Optional dynamicRangeFormat

dynamicRangeFormat?: H265DynamicRangeFormat

Automatically configures the H265 Video Codec to be compatible with the given SDR/HDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.

Memberof

H265VideoConfiguration

-

Optional dynamicRateDistortionStrength

dynamicRateDistortionStrength?: number

Increases the RD level at points where quality drops due to VBV rate control enforcement. Default 0.

+

Optional dynamicRateDistortionStrength

dynamicRateDistortionStrength?: number

Increases the RD level at points where quality drops due to VBV rate control enforcement. Default 0.

Memberof

H265VideoConfiguration

-

Optional earlySkip

earlySkip?: boolean

Measure 2Nx2N merge candidates first; if no residual is found, additional modes at that depth are not analysed.

+

Optional earlySkip

earlySkip?: boolean

Measure 2Nx2N merge candidates first; if no residual is found, additional modes at that depth are not analysed.

Memberof

H265VideoConfiguration

-

Optional enableHlgSignaling

enableHlgSignaling?: boolean

Enable SDR compatible HLG signaling. The container and bitstream will indicate BT.2020 but ARIB STD-B67 will be signaled in the alternative transfer characteristics SEI message.

+

Optional enableHlgSignaling

enableHlgSignaling?: boolean

Enable SDR compatible HLG signaling. The container and bitstream will indicate BT.2020 but ARIB STD-B67 will be signaled in the alternative transfer characteristics SEI message.

Memberof

H265VideoConfiguration

-

Optional enableHrdSignaling

enableHrdSignaling?: boolean

Signal hypothetical reference decoder (HRD) information

+

Optional enableHrdSignaling

enableHrdSignaling?: boolean

Signal hypothetical reference decoder (HRD) information

Memberof

H265VideoConfiguration

-

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

+

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

Memberof

VideoConfiguration

-

Optional evaluationOfIntraModesInBSlices

evaluationOfIntraModesInBSlices?: boolean

Enables the evaluation of intra modes in B slices.

+

Optional evaluationOfIntraModesInBSlices

evaluationOfIntraModesInBSlices?: boolean

Enables the evaluation of intra modes in B slices.

Memberof

H265VideoConfiguration

-

Optional fastSearchForAngularIntraPredictions

fastSearchForAngularIntraPredictions?: boolean

Enable faster search method for angular intra predictions.

+

Optional fastSearchForAngularIntraPredictions

fastSearchForAngularIntraPredictions?: boolean

Enable faster search method for angular intra predictions.

Memberof

H265VideoConfiguration

-

Optional forceFlush

forceFlush?: ForceFlushMode

Force the encoder to flush frames. Default is DISABLED.

+

Optional forceFlush

forceFlush?: ForceFlushMode

Force the encoder to flush frames. Default is DISABLED.

Memberof

H265VideoConfiguration

-

Optional gopLookahead

gopLookahead?: number

Number of frames for GOP boundary decision lookahead. Valid values 0 - rcLookahead. Default 0

+

Optional gopLookahead

gopLookahead?: number

Number of frames for GOP boundary decision lookahead. Valid values 0 - rcLookahead. Default 0

Memberof

H265VideoConfiguration

-

Optional grainOptimizedRateControl

grainOptimizedRateControl?: boolean

Enables a specialised ratecontrol algorithm for film grain content. Default false.

+

Optional grainOptimizedRateControl

grainOptimizedRateControl?: boolean

Enables a specialised ratecontrol algorithm for film grain content. Default false.

Memberof

H265VideoConfiguration

-

Optional hdr

hdr?: boolean

Force signaling of HDR parameters in SEI packets. Enabled automatically when masterDisplay or maxContentLightLevel/maxPictureAverageLightLevel are set. Useful when there is a desire to signal 0 values for maxContentLightLevel and maxPictureAverageLightLevel.

+

Optional hdr

hdr?: boolean

Force signaling of HDR parameters in SEI packets. Enabled automatically when masterDisplay or maxContentLightLevel/maxPictureAverageLightLevel are set. Useful when there is a desire to signal 0 values for maxContentLightLevel and maxPictureAverageLightLevel.

Memberof

H265VideoConfiguration

-

Optional height

height?: number

Height of the encoded video in pixels

+

Optional height

height?: number

Height of the encoded video in pixels

Memberof

VideoConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ipRatio

ipRatio?: number

QP ratio factor between I and P slices. This ratio is used in all of the rate control modes. Default 1.4

+

Optional ipRatio

ipRatio?: number

QP ratio factor between I and P slices. This ratio is used in all of the rate control modes. Default 1.4

Memberof

H265VideoConfiguration

-

Optional level

level?: LevelH265

Memberof

H265VideoConfiguration

-

Optional levelHighTier

levelHighTier?: boolean

If high tier is disabled the encoder will attempt to encode only at the main tier. Default is enabled.

+

Optional level

level?: LevelH265

Memberof

H265VideoConfiguration

+

Optional levelHighTier

levelHighTier?: boolean

If high tier is disabled the encoder will attempt to encode only at the main tier. Default is enabled.

Memberof

H265VideoConfiguration

-

Optional limitModes

limitModes?: boolean

When enabled, will limit modes analyzed for each CU using cost metrics from the 4 sub-CUs. This can significantly improve performance when rectangularMotionPartitionsAnalysis and/or asymetricMotionPartitionsAnalysis are enabled at minimal compression efficiency loss.

+

Optional limitModes

limitModes?: boolean

When enabled, will limit modes analyzed for each CU using cost metrics from the 4 sub-CUs. This can significantly improve performance when rectangularMotionPartitionsAnalysis and/or asymetricMotionPartitionsAnalysis are enabled at minimal compression efficiency loss.

Memberof

H265VideoConfiguration

-

Optional limitReferences

limitReferences?: LimitReferences

If enabled, limit references per depth, CU or both.

+

Optional limitReferences

limitReferences?: LimitReferences

If enabled, limit references per depth, CU or both.

Memberof

H265VideoConfiguration

-

Optional limitSao

limitSao?: boolean

Limit SAO filter computation by early terminating SAO process based on inter prediction mode, CTU spatial-domain correlations, and relations between luma and chroma. Default false.

+

Optional limitSao

limitSao?: boolean

Limit SAO filter computation by early terminating SAO process based on inter prediction mode, CTU spatial-domain correlations, and relations between luma and chroma. Default false.

Memberof

H265VideoConfiguration

-

Optional limitTransformUnitDepthRecursion

limitTransformUnitDepthRecursion?: LimitTransformUnitDepthRecursionMode

Enables early exit from transform unit depth recursion, for inter coded blocks. Default is DISABLED.

+

Optional limitTransformUnitDepthRecursion

limitTransformUnitDepthRecursion?: LimitTransformUnitDepthRecursionMode

Enables early exit from transform unit depth recursion, for inter coded blocks. Default is DISABLED.

Memberof

H265VideoConfiguration

-

Optional lookaheadSlices

lookaheadSlices?: number

Use multiple worker threads to measure the estimated cost of each frame within the lookahead. The higher this parameter, the less accurate the frame costs will be which will result in less accurate B-frame and scene-cut decisions. Valid range: 0 - 16

+

Optional lookaheadSlices

lookaheadSlices?: number

Use multiple worker threads to measure the estimated cost of each frame within the lookahead. The higher this parameter, the less accurate the frame costs will be which will result in less accurate B-frame and scene-cut decisions. Valid range: 0 - 16

Memberof

H265VideoConfiguration

-

Optional lowpassDct

lowpassDct?: boolean

Will use low-pass subband dct approximation instead of the standard dct for 16x16 and 32x32 blocks. Default false.

+

Optional lowpassDct

lowpassDct?: boolean

Will use low-pass subband dct approximation instead of the standard dct for 16x16 and 32x32 blocks. Default false.

Memberof

H265VideoConfiguration

-

Optional masterDisplay

masterDisplay?: string

Set the mastering display color volume SEI info (SMPTE ST 2086). For example G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1) describes a P3D65 1000-nits monitor, where G(x=0.265, y=0.690), B(x=0.150, y=0.060), R(x=0.680, y=0.320), WP(x=0.3127, y=0.3290), L(max=1000, min=0.0001). Part of HDR-10 metadata. If used on a Dolby Vision stream, this value must be set to G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1).

+

Optional masterDisplay

masterDisplay?: string

Set the mastering display color volume SEI info (SMPTE ST 2086). For example G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1) describes a P3D65 1000-nits monitor, where G(x=0.265, y=0.690), B(x=0.150, y=0.060), R(x=0.680, y=0.320), WP(x=0.3127, y=0.3290), L(max=1000, min=0.0001). Part of HDR-10 metadata. If used on a Dolby Vision stream, this value must be set to G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1).

Memberof

H265VideoConfiguration

-

Optional maxBitrate

maxBitrate?: number

Maximum Bitrate

+

Optional maxBitrate

maxBitrate?: number

Maximum Bitrate

Memberof

H265VideoConfiguration

-

Optional maxCTUSize

maxCTUSize?: MaxCtuSize

Memberof

H265VideoConfiguration

-

Optional maxContentLightLevel

maxContentLightLevel?: number

Set the max content light level (MaxCLL). Use together with maxPictureAverageLightLevel (which will be 0 if not set). Part of HDR-10 metadata.

+

Optional maxCTUSize

maxCTUSize?: MaxCtuSize

Memberof

H265VideoConfiguration

+

Optional maxContentLightLevel

maxContentLightLevel?: number

Set the max content light level (MaxCLL). Use together with maxPictureAverageLightLevel (which will be 0 if not set). Part of HDR-10 metadata.

Memberof

H265VideoConfiguration

-

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

+

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

Memberof

H265VideoConfiguration

-

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

+

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

Memberof

H265VideoConfiguration

-

Optional maxMerge

maxMerge?: number

Maximum number of neighbor (spatial and temporal) candidate blocks that the encoder may consider for merging motion predictions. Valid range: 1 - 5

+

Optional maxMerge

maxMerge?: number

Maximum number of neighbor (spatial and temporal) candidate blocks that the encoder may consider for merging motion predictions. Valid range: 1 - 5

Memberof

H265VideoConfiguration

-

Optional maxPictureAverageLightLevel

maxPictureAverageLightLevel?: number

Set the maximum picture average light level (MaxFALL). Use together with maxContentLightLevel (which will be 0 if not set). Part of HDR-10 metadata.

+

Optional maxPictureAverageLightLevel

maxPictureAverageLightLevel?: number

Set the maximum picture average light level (MaxFALL). Use together with maxContentLightLevel (which will be 0 if not set). Part of HDR-10 metadata.

Memberof

H265VideoConfiguration

-

Optional maximumTransformUnitSize

maximumTransformUnitSize?: MaxTransformUnitSize

Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.

+

Optional maximumTransformUnitSize

maximumTransformUnitSize?: MaxTransformUnitSize

Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.

Memberof

H265VideoConfiguration

-

Optional minBitrate

minBitrate?: number

Minimum Bitrate

+

Optional minBitrate

minBitrate?: number

Minimum Bitrate

Memberof

H265VideoConfiguration

-

Optional minCodingUnitSize

minCodingUnitSize?: MinCodingUnitSize

Minimum CU size (width and height). By using 16 or 32 the encoder will not analyze the cost of CUs below that minimum threshold, saving considerable amounts of compute with a predictable increase in bitrate. This setting has a large effect on performance on the faster presets.

+

Optional minCodingUnitSize

minCodingUnitSize?: MinCodingUnitSize

Minimum CU size (width and height). By using 16 or 32 the encoder will not analyze the cost of CUs below that minimum threshold, saving considerable amounts of compute with a predictable increase in bitrate. This setting has a large effect on performance on the faster presets.

Memberof

H265VideoConfiguration

-

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames

+

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames

Memberof

H265VideoConfiguration

-

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

+

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

Memberof

H265VideoConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional motionSearch

motionSearch?: MotionSearch

Memberof

H265VideoConfiguration

-

Optional motionSearchRange

motionSearchRange?: number

Set the Motion search range.

+

Optional motionSearch

motionSearch?: MotionSearch

Memberof

H265VideoConfiguration

+

Optional motionSearchRange

motionSearchRange?: number

Set the Motion search range.

Memberof

H265VideoConfiguration

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional noiseReductionInter

noiseReductionInter?: number

An integer value, which denotes strength of noise reduction in inter CUs. Default 0.

+

Optional noiseReductionInter

noiseReductionInter?: number

An integer value, which denotes strength of noise reduction in inter CUs. Default 0.

Memberof

H265VideoConfiguration

-

Optional noiseReductionIntra

noiseReductionIntra?: number

An integer value, which denotes strength of noise reduction in intra CUs. Default 0.

+

Optional noiseReductionIntra

noiseReductionIntra?: number

An integer value, which denotes strength of noise reduction in intra CUs. Default 0.

Memberof

H265VideoConfiguration

-

Optional openGop

openGop?: boolean

Enable open-gop, allows referencing frames from a previous gop

+

Optional openGop

openGop?: boolean

Enable open-gop, allows referencing frames from a previous gop

Memberof

H265VideoConfiguration

-

Optional pbRatio

pbRatio?: number

QP ratio factor between P and B slices. This ratio is used in all of the rate control modes. Default 1.3

+

Optional pbRatio

pbRatio?: number

QP ratio factor between P and B slices. This ratio is used in all of the rate control modes. Default 1.3

Memberof

H265VideoConfiguration

-

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

+

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Memberof

VideoConfiguration

-

Optional presetConfiguration

presetConfiguration?: PresetConfiguration

Choose from a set of preset configurations tailored for common use cases. Check out H265 Presets to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.

+

Optional presetConfiguration

presetConfiguration?: PresetConfiguration

Choose from a set of preset configurations tailored for common use cases. Check out H265 Presets to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.

Memberof

H265VideoConfiguration

-

Optional profile

profile?: ProfileH265

Memberof

H265VideoConfiguration

-

Optional psyRateDistortionOptimization

psyRateDistortionOptimization?: number

Psycho-visual rate-distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP, RD_REF_ALL, QPRD or FULL_RD

+

Optional profile

profile?: ProfileH265

Memberof

H265VideoConfiguration

+

Optional psyRateDistortionOptimization

psyRateDistortionOptimization?: number

Psycho-visual rate-distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP, RD_REF_ALL, QPRD or FULL_RD

Memberof

H265VideoConfiguration

-

Optional psyRateDistortionOptimizedQuantization

psyRateDistortionOptimizedQuantization?: number

Strength of psycho-visual optimizations in quantization. Only has an effect in presets which use RDOQ (rd-levels 4 and 5). The value must be between 0 and 50, 1.0 is typical

+

Optional psyRateDistortionOptimizedQuantization

psyRateDistortionOptimizedQuantization?: number

Strength of psycho-visual optimizations in quantization. Only has an effect in presets which use RDOQ (rd-levels 4 and 5). The value must be between 0 and 50, 1.0 is typical

Memberof

H265VideoConfiguration

-

Optional qp

qp?: number

Quantization factor

+

Optional qp

qp?: number

Quantization factor

Memberof

H265VideoConfiguration

-

Optional qpMax

qpMax?: number

Maximum quantization factor. Valid value range: 0 - 69

+

Optional qpMax

qpMax?: number

Maximum quantization factor. Valid value range: 0 - 69

Memberof

H265VideoConfiguration

-

Optional qpMin

qpMin?: number

Minimum quantization factor. Valid value range: 0 - 69

+

Optional qpMin

qpMin?: number

Minimum quantization factor. Valid value range: 0 - 69

Memberof

H265VideoConfiguration

-

Optional qpOffsetChromaCb

qpOffsetChromaCb?: number

Offset of Cb chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0

+

Optional qpOffsetChromaCb

qpOffsetChromaCb?: number

Offset of Cb chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0

Memberof

H265VideoConfiguration

-

Optional qpOffsetChromaCr

qpOffsetChromaCr?: number

Offset of Cr chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0

+

Optional qpOffsetChromaCr

qpOffsetChromaCr?: number

Offset of Cr chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0

Memberof

H265VideoConfiguration

-

Optional qpStep

qpStep?: number

The maximum single adjustment in QP allowed to rate control. Default 4

+

Optional qpStep

qpStep?: number

The maximum single adjustment in QP allowed to rate control. Default 4

Memberof

H265VideoConfiguration

-

Optional quantizationGroupSize

quantizationGroupSize?: QuantizationGroupSize

Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted. Default is same as maxCTUSize.

+

Optional quantizationGroupSize

quantizationGroupSize?: QuantizationGroupSize

Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted. Default is same as maxCTUSize.

Memberof

H265VideoConfiguration

-

Optional quantizerCurveCompressionFactor

quantizerCurveCompressionFactor?: number

Quantizer curve compression factor. It weights the frame quantizer based on the complexity of residual (measured by lookahead). Default 0.6

+

Optional quantizerCurveCompressionFactor

quantizerCurveCompressionFactor?: number

Quantizer curve compression factor. It weights the frame quantizer based on the complexity of residual (measured by lookahead). Default 0.6

Memberof

H265VideoConfiguration

-

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

+

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

Memberof

VideoConfiguration

-

Optional rateDistortionLevelForModeDecision

rateDistortionLevelForModeDecision?: number

Level of rate-distortion optimization in mode decision. The lower the value the faster the encode, the higher the value higher the compression efficiency. Valid range: 0 - 4

+

Optional rateDistortionLevelForModeDecision

rateDistortionLevelForModeDecision?: number

Level of rate-distortion optimization in mode decision. The lower the value the faster the encode, the higher the value higher the compression efficiency. Valid range: 0 - 4

Memberof

H265VideoConfiguration

-

Optional rateDistortionLevelForQuantization

rateDistortionLevelForQuantization?: RateDistortionLevelForQuantization

Specifies the amount of rate-distortion analysis to use within quantization.

+

Optional rateDistortionLevelForQuantization

rateDistortionLevelForQuantization?: RateDistortionLevelForQuantization

Specifies the amount of rate-distortion analysis to use within quantization.

Memberof

H265VideoConfiguration

-

Optional rateDistortionPenalty

rateDistortionPenalty?: RateDistortionPenaltyMode

Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.

+

Optional rateDistortionPenalty

rateDistortionPenalty?: RateDistortionPenaltyMode

Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.

Memberof

H265VideoConfiguration

-

Optional rcLookahead

rcLookahead?: number

Number of frames for slice-type decision lookahead

+

Optional rcLookahead

rcLookahead?: number

Number of frames for slice-type decision lookahead

Memberof

H265VideoConfiguration

-

Optional rectangularMotionPartitionsAnalysis

rectangularMotionPartitionsAnalysis?: boolean

Enable analysis of rectangular motion partitions Nx2N and 2NxN.

+

Optional rectangularMotionPartitionsAnalysis

rectangularMotionPartitionsAnalysis?: boolean

Enable analysis of rectangular motion partitions Nx2N and 2NxN.

Memberof

H265VideoConfiguration

-

Optional recursionSkip

recursionSkip?: boolean

If enabled exits early from CU depth recursion. When a skip CU is found, additional heuristics are used to decide whether to terminate recursion.

+

Optional recursionSkip

recursionSkip?: boolean

If enabled exits early from CU depth recursion. When a skip CU is found, additional heuristics are used to decide whether to terminate recursion.

Memberof

H265VideoConfiguration

-

Optional refFrames

refFrames?: number

Amount of reference frames

+

Optional refFrames

refFrames?: number

Amount of reference frames

Memberof

H265VideoConfiguration

-

Optional refineRateDistortionCost

refineRateDistortionCost?: boolean

Enable QP based rate distortion refinement. Default is disabled.

+

Optional refineRateDistortionCost

refineRateDistortionCost?: boolean

Enable QP based rate distortion refinement. Default is disabled.

Memberof

H265VideoConfiguration

-

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sao

sao?: boolean

Toggle sample adaptive offset loop filter

+

Optional sao

sao?: boolean

Toggle sample adaptive offset loop filter

Memberof

H265VideoConfiguration

-

Optional saoNonDeblock

saoNonDeblock?: boolean

Specify how to handle depencency between SAO and deblocking filter. When enabled, non-deblocked pixels are used for SAO analysis. When disabled, SAO analysis skips the right/bottom boundary areas. Default false.

+

Optional saoNonDeblock

saoNonDeblock?: boolean

Specify how to handle depencency between SAO and deblocking filter. When enabled, non-deblocked pixels are used for SAO analysis. When disabled, SAO analysis skips the right/bottom boundary areas. Default false.

Memberof

H265VideoConfiguration

-

Optional sceneCutThreshold

sceneCutThreshold?: number

Scene Change sensitivity. The higher the value, the more likely an I-Frame will be inserted. Set to 0 to disable it.

+

Optional sceneCutThreshold

sceneCutThreshold?: number

Scene Change sensitivity. The higher the value, the more likely an I-Frame will be inserted. Set to 0 to disable it.

Memberof

H265VideoConfiguration

-

Optional scenecutBias

scenecutBias?: number

This value represents the percentage difference between the inter cost and intra cost of a frame used in scenecut detection. Default 5.0.

+

Optional scenecutBias

scenecutBias?: number

This value represents the percentage difference between the inter cost and intra cost of a frame used in scenecut detection. Default 5.0.

Memberof

H265VideoConfiguration

-

Optional signHide

signHide?: boolean

Hide sign bit of one coefficient per coding tree unit.

+

Optional signHide

signHide?: boolean

Hide sign bit of one coefficient per coding tree unit.

Memberof

H265VideoConfiguration

-

Optional skipSplitRateDistortionAnalysis

skipSplitRateDistortionAnalysis?: boolean

Enable skipping split rate distortion analysis when sum of split CU RD cost larger than one split CU RD cost for intra CU. Default disabled.

+

Optional skipSplitRateDistortionAnalysis

skipSplitRateDistortionAnalysis?: boolean

Enable skipping split rate distortion analysis when sum of split CU RD cost larger than one split CU RD cost for intra CU. Default disabled.

Memberof

H265VideoConfiguration

-

Optional slices

slices?: number

Encode each incoming frame as multiple parallel slices that may be decoded independently. Default is 1.

+

Optional slices

slices?: number

Encode each incoming frame as multiple parallel slices that may be decoded independently. Default is 1.

Memberof

H265VideoConfiguration

-

Optional ssimRateDistortionOptimization

ssimRateDistortionOptimization?: boolean

It is used for mode selection during analysis of CTUs and can achieve significant gain in terms of objective quality metrics SSIM and PSNR. Default false.

+

Optional ssimRateDistortionOptimization

ssimRateDistortionOptimization?: boolean

It is used for mode selection during analysis of CTUs and can achieve significant gain in terms of objective quality metrics SSIM and PSNR. Default false.

Memberof

H265VideoConfiguration

-

Optional strictCbr

strictCbr?: boolean

Enables stricter conditions to control bitrate deviance from the target bitrate in ABR mode. Bit rate adherence is prioritised over quality. Default false.

+

Optional strictCbr

strictCbr?: boolean

Enables stricter conditions to control bitrate deviance from the target bitrate in ABR mode. Bit rate adherence is prioritised over quality. Default false.

Memberof

H265VideoConfiguration

-

Optional strongIntraSmoothing

strongIntraSmoothing?: boolean

Enable strong intra smoothing for 32x32 intra blocks. Default true.

+

Optional strongIntraSmoothing

strongIntraSmoothing?: boolean

Enable strong intra smoothing for 32x32 intra blocks. Default true.

Memberof

H265VideoConfiguration

-

Optional subMe

subMe?: number

Set the amount of subpel refinement to perform.

+

Optional subMe

subMe?: number

Set the amount of subpel refinement to perform.

Memberof

H265VideoConfiguration

-

Optional temporalMotionVectorPredictors

temporalMotionVectorPredictors?: boolean

Enable temporal motion vector predictors in P and B slices. Default true.

+

Optional temporalMotionVectorPredictors

temporalMotionVectorPredictors?: boolean

Enable temporal motion vector predictors in P and B slices. Default true.

Memberof

H265VideoConfiguration

-

Optional transformSkip

transformSkip?: TransformSkipMode

Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks. Default is NONE.

+

Optional transformSkip

transformSkip?: TransformSkipMode

Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks. Default is NONE.

Memberof

H265VideoConfiguration

-

Optional tuInterDepth

tuInterDepth?: TuInterDepth

Memberof

H265VideoConfiguration

-

Optional tuIntraDepth

tuIntraDepth?: TuIntraDepth

Memberof

H265VideoConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.H265

Discriminator property for CodecConfiguration

+

Optional tuInterDepth

tuInterDepth?: TuInterDepth

Memberof

H265VideoConfiguration

+

Optional tuIntraDepth

tuIntraDepth?: TuIntraDepth

Memberof

H265VideoConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.H265

Discriminator property for CodecConfiguration

Memberof

H265VideoConfiguration

-

Optional videoFormat

videoFormat?: VideoFormat

Specifies the source format of the original analog video prior to digitizing and encoding

+

Optional videoFormat

videoFormat?: VideoFormat

Specifies the source format of the original analog video prior to digitizing and encoding

Memberof

H265VideoConfiguration

-

Optional wavefrontParallelProcessing

wavefrontParallelProcessing?: boolean

The encoder may begin encoding a row as soon as the row above it is at least two CTUs ahead in the encode process. Default is enabled.

+

Optional wavefrontParallelProcessing

wavefrontParallelProcessing?: boolean

The encoder may begin encoding a row as soon as the row above it is at least two CTUs ahead in the encode process. Default is enabled.

Memberof

H265VideoConfiguration

-

Optional weightPredictionOnBSlice

weightPredictionOnBSlice?: boolean

Enable weighted prediction in B slices

+

Optional weightPredictionOnBSlice

weightPredictionOnBSlice?: boolean

Enable weighted prediction in B slices

Memberof

H265VideoConfiguration

-

Optional weightPredictionOnPSlice

weightPredictionOnPSlice?: boolean

Enable weighted prediction in P slices

+

Optional weightPredictionOnPSlice

weightPredictionOnPSlice?: boolean

Enable weighted prediction in P slices

Memberof

H265VideoConfiguration

-

Optional width

width?: number

Width of the encoded video in pixels

+

Optional width

width?: number

Width of the encoded video in pixels

Memberof

VideoConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradaptiveQuantizationModeadaptiveQuantizationMotionadaptiveQuantizationStrengthallowedRADLBeforeIDRanalyzeSourceFramePixelsasymetricMotionPartitionsAnalysisautoLevelSetupbAdaptbframeBiasbframesbitrateblurComplexityblurQuantsbufsizecea608708SubtitleConfigcodingUnitLosslesscolorConfigconstrainedIntraPredictioncopyPicturecreatedAtcrfcustomDatacutreedescriptiondisplayAspectRatiodynamicRangeFormatdynamicRateDistortionStrengthearlySkipenableHlgSignalingenableHrdSignalingencodingModeevaluationOfIntraModesInBSlicesfastSearchForAngularIntraPredictionsforceFlushgopLookaheadgrainOptimizedRateControlhdrheightidipRatiolevellevelHighTierlimitModeslimitReferenceslimitSaolimitTransformUnitDepthRecursionlookaheadSliceslowpassDctmasterDisplaymaxBitratemaxCTUSizemaxContentLightLevelmaxGopmaxKeyframeIntervalmaxMergemaxPictureAverageLightLevelmaximumTransformUnitSizeminBitrateminCodingUnitSizeminGopminKeyframeIntervalmodifiedAtmotionSearchmotionSearchRangenamenoiseReductionInternoiseReductionIntraopenGoppbRatiopixelFormatpresetConfigurationprofilepsyRateDistortionOptimizationpsyRateDistortionOptimizedQuantizationqpqpMaxqpMinqpOffsetChromaCbqpOffsetChromaCrqpStepquantizationGroupSizequantizerCurveCompressionFactorraterateDistortionLevelForModeDecisionrateDistortionLevelForQuantizationrateDistortionPenaltyrcLookaheadrectangularMotionPartitionsAnalysisrecursionSkiprefFramesrefineRateDistortionCostsampleAspectRatioDenominatorsampleAspectRatioNumeratorsaosaoNonDeblocksceneCutThresholdscenecutBiassignHideskipSplitRateDistortionAnalysisslicesssimRateDistortionOptimizationstrictCbrstrongIntraSmoothingsubMetemporalMotionVectorPredictorstransformSkiptuInterDepthtuIntraDepthtypevideoFormatwavefrontParallelProcessingweightPredictionOnBSliceweightPredictionOnPSlicewidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradaptiveQuantizationModeadaptiveQuantizationMotionadaptiveQuantizationStrengthallowedRADLBeforeIDRanalyzeSourceFramePixelsasymetricMotionPartitionsAnalysisautoLevelSetupbAdaptbframeBiasbframesbitrateblurComplexityblurQuantsbufsizecea608708SubtitleConfigcodingUnitLosslesscolorConfigconstrainedIntraPredictioncopyPicturecreatedAtcrfcustomDatacutreedescriptiondisplayAspectRatiodynamicRangeFormatdynamicRateDistortionStrengthearlySkipenableHlgSignalingenableHrdSignalingencodingModeevaluationOfIntraModesInBSlicesfastSearchForAngularIntraPredictionsforceFlushgopLookaheadgrainOptimizedRateControlhdrheightidipRatiolevellevelHighTierlimitModeslimitReferenceslimitSaolimitTransformUnitDepthRecursionlookaheadSliceslowpassDctmasterDisplaymaxBitratemaxCTUSizemaxContentLightLevelmaxGopmaxKeyframeIntervalmaxMergemaxPictureAverageLightLevelmaximumTransformUnitSizeminBitrateminCodingUnitSizeminGopminKeyframeIntervalmodifiedAtmotionSearchmotionSearchRangenamenoiseReductionInternoiseReductionIntraopenGoppbRatiopixelFormatpresetConfigurationprofilepsyRateDistortionOptimizationpsyRateDistortionOptimizedQuantizationqpqpMaxqpMinqpOffsetChromaCbqpOffsetChromaCrqpStepquantizationGroupSizequantizerCurveCompressionFactorraterateDistortionLevelForModeDecisionrateDistortionLevelForQuantizationrateDistortionPenaltyrcLookaheadrectangularMotionPartitionsAnalysisrecursionSkiprefFramesrefineRateDistortionCostsampleAspectRatioDenominatorsampleAspectRatioNumeratorsaosaoNonDeblocksceneCutThresholdscenecutBiassignHideskipSplitRateDistortionAnalysisslicesssimRateDistortionOptimizationstrictCbrstrongIntraSmoothingsubMetemporalMotionVectorPredictorstransformSkiptuInterDepthtuIntraDepthtypevideoFormatwavefrontParallelProcessingweightPredictionOnBSliceweightPredictionOnPSlicewidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/HeAacV1AudioConfiguration.html b/docs/classes/HeAacV1AudioConfiguration.html index e64a9e40d..f287a282e 100644 --- a/docs/classes/HeAacV1AudioConfiguration.html +++ b/docs/classes/HeAacV1AudioConfiguration.html @@ -1,5 +1,5 @@ HeAacV1AudioConfiguration | @bitmovin/api-sdk

Class HeAacV1AudioConfiguration

Export

HeAacV1AudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: AacChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: AacChannelLayout

Channel layout of the audio codec configuration

Memberof

HeAacV1AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Optional signaling

signaling?: HeAacV1Signaling

Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.

+

Optional signaling

signaling?: HeAacV1Signaling

Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.

Memberof

HeAacV1AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.HE_AAC_V1

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.HE_AAC_V1

Discriminator property for CodecConfiguration

Memberof

HeAacV1AudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratesignalingtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratesignalingtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/HeAacV2AudioConfiguration.html b/docs/classes/HeAacV2AudioConfiguration.html index 06cf2ee16..bb5e97d90 100644 --- a/docs/classes/HeAacV2AudioConfiguration.html +++ b/docs/classes/HeAacV2AudioConfiguration.html @@ -1,5 +1,5 @@ HeAacV2AudioConfiguration | @bitmovin/api-sdk

Class HeAacV2AudioConfiguration

Export

HeAacV2AudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: AacChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: AacChannelLayout

Channel layout of the audio codec configuration

Memberof

HeAacV2AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Optional signaling

signaling?: HeAacV2Signaling

Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.

+

Optional signaling

signaling?: HeAacV2Signaling

Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.

Memberof

HeAacV2AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.HE_AAC_V2

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.HE_AAC_V2

Discriminator property for CodecConfiguration

Memberof

HeAacV2AudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratesignalingtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratesignalingtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/HistoryEncoding.html b/docs/classes/HistoryEncoding.html index 4a2d83fca..4cca57ddb 100644 --- a/docs/classes/HistoryEncoding.html +++ b/docs/classes/HistoryEncoding.html @@ -1,5 +1,5 @@ HistoryEncoding | @bitmovin/api-sdk

Class HistoryEncoding

Export

HistoryEncoding

-

Constructors

constructor +

Constructors

constructor

Properties

convertSccCaptions? encoding? inputStreams? @@ -12,21 +12,21 @@ streams? transferRetries? vodStartReqeust? -

Constructors

constructor

Properties

Optional convertSccCaptions

convertSccCaptions?: ConvertSccCaption[]

Memberof

HistoryEncoding

-

Optional encoding

encoding?: Encoding

Encoding

+

Constructors

constructor

Properties

Optional convertSccCaptions

convertSccCaptions?: ConvertSccCaption[]

Memberof

HistoryEncoding

+

Optional encoding

encoding?: Encoding

Encoding

Memberof

HistoryEncoding

-

Optional inputStreams

inputStreams?: StreamInput[]

Memberof

HistoryEncoding

-

Optional keyFrames

keyFrames?: Keyframe[]

Memberof

HistoryEncoding

-

Optional live

live?: LiveEncoding

Live Details

+

Optional inputStreams

inputStreams?: StreamInput[]

Memberof

HistoryEncoding

+

Optional keyFrames

keyFrames?: Keyframe[]

Memberof

HistoryEncoding

+

Optional live

live?: LiveEncoding

Live Details

Memberof

HistoryEncoding

-

Optional liveStartReqeust

liveStartReqeust?: StartLiveEncodingRequest

Live Encoding Start Request

+

Optional liveStartReqeust

liveStartReqeust?: StartLiveEncodingRequest

Live Encoding Start Request

Memberof

HistoryEncoding

-

Optional muxings

muxings?: HistoryMuxing[]

Memberof

HistoryEncoding

-

Optional sidecarFiles

sidecarFiles?: SidecarFile[]

Memberof

HistoryEncoding

-

Optional status

status?: Task

Encoding Status

+

Optional muxings

muxings?: HistoryMuxing[]

Memberof

HistoryEncoding

+

Optional sidecarFiles

sidecarFiles?: SidecarFile[]

Memberof

HistoryEncoding

+

Optional status

status?: Task

Encoding Status

Memberof

HistoryEncoding

-

Optional streams

streams?: HistoryStream[]

Memberof

HistoryEncoding

-

Optional transferRetries

transferRetries?: TransferRetry[]

Memberof

HistoryEncoding

-

Optional vodStartReqeust

vodStartReqeust?: StartEncodingRequest

VOD Encoding Start Request

+

Optional streams

streams?: HistoryStream[]

Memberof

HistoryEncoding

+

Optional transferRetries

transferRetries?: TransferRetry[]

Memberof

HistoryEncoding

+

Optional vodStartReqeust

vodStartReqeust?: StartEncodingRequest

VOD Encoding Start Request

Memberof

HistoryEncoding

-

Settings

Member Visibility

Theme

On This Page

constructorconvertSccCaptionsencodinginputStreamskeyFramesliveliveStartReqeustmuxingssidecarFilesstatusstreamstransferRetriesvodStartReqeust
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorconvertSccCaptionsencodinginputStreamskeyFramesliveliveStartReqeustmuxingssidecarFilesstatusstreamstransferRetriesvodStartReqeust
\ No newline at end of file diff --git a/docs/classes/HistoryMuxing.html b/docs/classes/HistoryMuxing.html index 0892bacfb..31b69d455 100644 --- a/docs/classes/HistoryMuxing.html +++ b/docs/classes/HistoryMuxing.html @@ -1,5 +1,5 @@ HistoryMuxing | @bitmovin/api-sdk

Class HistoryMuxing

Export

HistoryMuxing

-

Constructors

constructor +

Constructors

constructor

Properties

broadcastTsMuxingInformation? drms? fmp4MuxingInformation? @@ -10,15 +10,15 @@ progressiveMovMuxingInformation? progressiveTsMuxingInformation? progressiveWebmMuxingInformation? -

Constructors

constructor

Properties

Optional broadcastTsMuxingInformation

broadcastTsMuxingInformation?: BroadcastTsMuxingInformation

Memberof

HistoryMuxing

-

Optional drms

drms?: Drm[]

Memberof

HistoryMuxing

-

Optional fmp4MuxingInformation

fmp4MuxingInformation?: Fmp4MuxingInformation

Memberof

HistoryMuxing

-

Optional mp3MuxingInformation

mp3MuxingInformation?: Mp3MuxingInformation

Memberof

HistoryMuxing

-

Optional mp4MuxingInformation

mp4MuxingInformation?: Mp4MuxingInformation

Memberof

HistoryMuxing

-

Optional muxing

muxing?: Muxing

Muxing

+

Constructors

constructor

Properties

Optional broadcastTsMuxingInformation

broadcastTsMuxingInformation?: BroadcastTsMuxingInformation

Memberof

HistoryMuxing

+

Optional drms

drms?: Drm[]

Memberof

HistoryMuxing

+

Optional fmp4MuxingInformation

fmp4MuxingInformation?: Fmp4MuxingInformation

Memberof

HistoryMuxing

+

Optional mp3MuxingInformation

mp3MuxingInformation?: Mp3MuxingInformation

Memberof

HistoryMuxing

+

Optional mp4MuxingInformation

mp4MuxingInformation?: Mp4MuxingInformation

Memberof

HistoryMuxing

+

Optional muxing

muxing?: Muxing

Muxing

Memberof

HistoryMuxing

-

Optional packedAudioMuxingInformation

packedAudioMuxingInformation?: PackedAudioMuxingInformation

Memberof

HistoryMuxing

-

Optional progressiveMovMuxingInformation

progressiveMovMuxingInformation?: ProgressiveMovMuxingInformation

Memberof

HistoryMuxing

-

Optional progressiveTsMuxingInformation

progressiveTsMuxingInformation?: ProgressiveTsMuxingInformation

Memberof

HistoryMuxing

-

Optional progressiveWebmMuxingInformation

progressiveWebmMuxingInformation?: ProgressiveWebmMuxingInformation

Memberof

HistoryMuxing

-

Settings

Member Visibility

Theme

On This Page

constructorbroadcastTsMuxingInformationdrmsfmp4MuxingInformationmp3MuxingInformationmp4MuxingInformationmuxingpackedAudioMuxingInformationprogressiveMovMuxingInformationprogressiveTsMuxingInformationprogressiveWebmMuxingInformation
\ No newline at end of file +

Optional packedAudioMuxingInformation

packedAudioMuxingInformation?: PackedAudioMuxingInformation

Memberof

HistoryMuxing

+

Optional progressiveMovMuxingInformation

progressiveMovMuxingInformation?: ProgressiveMovMuxingInformation

Memberof

HistoryMuxing

+

Optional progressiveTsMuxingInformation

progressiveTsMuxingInformation?: ProgressiveTsMuxingInformation

Memberof

HistoryMuxing

+

Optional progressiveWebmMuxingInformation

progressiveWebmMuxingInformation?: ProgressiveWebmMuxingInformation

Memberof

HistoryMuxing

+

Settings

Member Visibility

Theme

On This Page

constructorbroadcastTsMuxingInformationdrmsfmp4MuxingInformationmp3MuxingInformationmp4MuxingInformationmuxingpackedAudioMuxingInformationprogressiveMovMuxingInformationprogressiveTsMuxingInformationprogressiveWebmMuxingInformation
\ No newline at end of file diff --git a/docs/classes/HistoryStream.html b/docs/classes/HistoryStream.html index fc7e40f3f..f4a848211 100644 --- a/docs/classes/HistoryStream.html +++ b/docs/classes/HistoryStream.html @@ -1,5 +1,5 @@ HistoryStream | @bitmovin/api-sdk

Class HistoryStream

Export

HistoryStream

-

Constructors

constructor +

Constructors

constructor

Properties

bifs? burnInSubtitleDvbSubs? burnInSubtitleSrtSubs? @@ -11,26 +11,26 @@ sprites? stream? thumbnails? -

Constructors

constructor

Properties

Optional bifs

bifs?: Bif[]

List of bif configurations

+

Constructors

constructor

Properties

Optional bifs

bifs?: Bif[]

List of bif configurations

Memberof

HistoryStream

-

Optional burnInSubtitleDvbSubs

burnInSubtitleDvbSubs?: BurnInSubtitleDvbSub[]

List of Burn-In DVB-SUB subtitles

+

Optional burnInSubtitleDvbSubs

burnInSubtitleDvbSubs?: BurnInSubtitleDvbSub[]

List of Burn-In DVB-SUB subtitles

Memberof

HistoryStream

-

Optional burnInSubtitleSrtSubs

burnInSubtitleSrtSubs?: BurnInSubtitleSrt[]

List of burn-in SRT configurations

+

Optional burnInSubtitleSrtSubs

burnInSubtitleSrtSubs?: BurnInSubtitleSrt[]

List of burn-in SRT configurations

Memberof

HistoryStream

-

Optional dolbyVisionMetadata

dolbyVisionMetadata?: DolbyVisionMetadata[]

List of Dolby Vision Metadata configurations

+

Optional dolbyVisionMetadata

dolbyVisionMetadata?: DolbyVisionMetadata[]

List of Dolby Vision Metadata configurations

Memberof

HistoryStream

-

Optional filters

filters?: StreamFilter[]

List of stream filter configurations

+

Optional filters

filters?: StreamFilter[]

List of stream filter configurations

Memberof

HistoryStream

-

Optional nexGuardFileMarker

nexGuardFileMarker?: NexGuardFileMarker

Nexguard file marker watermarking configuration

+

Optional nexGuardFileMarker

nexGuardFileMarker?: NexGuardFileMarker

Nexguard file marker watermarking configuration

Memberof

HistoryStream

-

Optional psnrMetrics

psnrMetrics?: PsnrQualityMetric[]

List of PSNR quality metrics

+

Optional psnrMetrics

psnrMetrics?: PsnrQualityMetric[]

List of PSNR quality metrics

Memberof

HistoryStream

-

Optional sccCaptions

sccCaptions?: SccCaption[]

List of caption configurations

+

Optional sccCaptions

sccCaptions?: SccCaption[]

List of caption configurations

Memberof

HistoryStream

-

Optional sprites

sprites?: Sprite[]

List of Sprite configurations

+

Optional sprites

sprites?: Sprite[]

List of Sprite configurations

Memberof

HistoryStream

-

Optional stream

stream?: Stream

Stream

+

Optional stream

stream?: Stream

Stream

Memberof

HistoryStream

-

Optional thumbnails

thumbnails?: Thumbnail[]

List of Thumbnail configurations

+

Optional thumbnails

thumbnails?: Thumbnail[]

List of Thumbnail configurations

Memberof

HistoryStream

-

Settings

Member Visibility

Theme

On This Page

constructorbifsburnInSubtitleDvbSubsburnInSubtitleSrtSubsdolbyVisionMetadatafiltersnexGuardFileMarkerpsnrMetricssccCaptionsspritesstreamthumbnails
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbifsburnInSubtitleDvbSubsburnInSubtitleSrtSubsdolbyVisionMetadatafiltersnexGuardFileMarkerpsnrMetricssccCaptionsspritesstreamthumbnails
\ No newline at end of file diff --git a/docs/classes/HlsManifest.html b/docs/classes/HlsManifest.html index 5d497d0c5..5775d992c 100644 --- a/docs/classes/HlsManifest.html +++ b/docs/classes/HlsManifest.html @@ -1,5 +1,5 @@ HlsManifest | @bitmovin/api-sdk

Class HlsManifest

Export

HlsManifest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

channelsAttributeForAudio? createdAt? customData? @@ -14,31 +14,31 @@ status? targetDurationRoundingMode? type? -

Constructors

constructor

Properties

Optional channelsAttributeForAudio

channelsAttributeForAudio?: ChannelsAttributeForAudio

Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag

+

Constructors

constructor

Properties

Optional channelsAttributeForAudio

channelsAttributeForAudio?: ChannelsAttributeForAudio

Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag

Memberof

HlsManifest

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional hlsMasterPlaylistVersion

hlsMasterPlaylistVersion?: HlsVersion

If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version

+

Optional hlsMasterPlaylistVersion

hlsMasterPlaylistVersion?: HlsVersion

If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version

Memberof

HlsManifest

-

Optional hlsMediaPlaylistVersion

hlsMediaPlaylistVersion?: HlsVersion

If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version

+

Optional hlsMediaPlaylistVersion

hlsMediaPlaylistVersion?: HlsVersion

If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version

Memberof

HlsManifest

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional manifestName

manifestName?: string

The filename of your manifest. If this is not set, the name is used as output file name. Either one of name or manifestName is required. Be aware that spaces will be replaced with underlines (_) on the output.

+

Optional manifestName

manifestName?: string

The filename of your manifest. If this is not set, the name is used as output file name. Either one of name or manifestName is required. Be aware that spaces will be replaced with underlines (_) on the output.

Memberof

HlsManifest

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

+

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

Memberof

Manifest

-

Optional status

status?: Status

Current status

+

Optional status

status?: Status

Current status

Memberof

Manifest

-

Optional targetDurationRoundingMode

targetDurationRoundingMode?: HlsTargetDurationRoundingMode

The rounding applied to target duration. Two possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer, or UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.

+

Optional targetDurationRoundingMode

targetDurationRoundingMode?: HlsTargetDurationRoundingMode

The rounding applied to target duration. Two possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer, or UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.

Memberof

HlsManifest

-

Optional type

type?: ManifestType

Memberof

Manifest

-

Settings

Member Visibility

Theme

On This Page

constructorchannelsAttributeForAudiocreatedAtcustomDatadescriptionhlsMasterPlaylistVersionhlsMediaPlaylistVersionidmanifestNamemodifiedAtnameoutputsstatustargetDurationRoundingModetype
\ No newline at end of file +

Optional type

type?: ManifestType

Memberof

Manifest

+

Settings

Member Visibility

Theme

On This Page

constructorchannelsAttributeForAudiocreatedAtcustomDatadescriptionhlsMasterPlaylistVersionhlsMediaPlaylistVersionidmanifestNamemodifiedAtnameoutputsstatustargetDurationRoundingModetype
\ No newline at end of file diff --git a/docs/classes/HlsManifestAdMarkerSettings.html b/docs/classes/HlsManifestAdMarkerSettings.html index 9c14848ae..a34d6c12e 100644 --- a/docs/classes/HlsManifestAdMarkerSettings.html +++ b/docs/classes/HlsManifestAdMarkerSettings.html @@ -1,6 +1,6 @@ HlsManifestAdMarkerSettings | @bitmovin/api-sdk

Class HlsManifestAdMarkerSettings

Export

HlsManifestAdMarkerSettings

-

Constructors

constructor +

Constructors

constructor

Properties

enabledMarkerTypes? -

Constructors

constructor

Properties

Optional enabledMarkerTypes

enabledMarkerTypes?: HlsManifestAdMarkerType[]

Ad marker types that will be inserted. More than one type is possible. - EXT_X_CUE_OUT_IN: Ad markers will be inserted using #EXT-X-CUE-OUT and #EXT-X-CUE-IN tags - EXT_OATCLS_SCTE35: Ad markers will be inserted using #EXT-OATCLS-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger. - EXT_X_SPLICEPOINT_SCTE35: Ad markers will be inserted using #EXT-X-SPLICEPOINT-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger. - EXT_X_DATERANGE: Ad markers will be inserted using #EXT-X-DATERANGE tags. They contain the ID, start timestamp and hex encoded raw bytes of the original SCTE-35 trigger. - EXT_X_SCTE35: Ad markers will be inserted using #EXT-X-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.

+

Constructors

constructor

Properties

Optional enabledMarkerTypes

enabledMarkerTypes?: HlsManifestAdMarkerType[]

Ad marker types that will be inserted. More than one type is possible. - EXT_X_CUE_OUT_IN: Ad markers will be inserted using #EXT-X-CUE-OUT and #EXT-X-CUE-IN tags - EXT_OATCLS_SCTE35: Ad markers will be inserted using #EXT-OATCLS-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger. - EXT_X_SPLICEPOINT_SCTE35: Ad markers will be inserted using #EXT-X-SPLICEPOINT-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger. - EXT_X_DATERANGE: Ad markers will be inserted using #EXT-X-DATERANGE tags. They contain the ID, start timestamp and hex encoded raw bytes of the original SCTE-35 trigger. - EXT_X_SCTE35: Ad markers will be inserted using #EXT-X-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.

Memberof

HlsManifestAdMarkerSettings

-

Settings

Member Visibility

Theme

On This Page

constructorenabledMarkerTypes
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorenabledMarkerTypes
\ No newline at end of file diff --git a/docs/classes/HlsManifestDefault.html b/docs/classes/HlsManifestDefault.html index 002281109..81f7367c3 100644 --- a/docs/classes/HlsManifestDefault.html +++ b/docs/classes/HlsManifestDefault.html @@ -1,5 +1,5 @@ HlsManifestDefault | @bitmovin/api-sdk

Class HlsManifestDefault

Export

HlsManifestDefault

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

channelsAttributeForAudio? createdAt? customData? @@ -16,35 +16,35 @@ targetDurationRoundingMode? type? version? -

Constructors

constructor

Properties

Optional channelsAttributeForAudio

channelsAttributeForAudio?: ChannelsAttributeForAudio

Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag

+

Constructors

constructor

Properties

Optional channelsAttributeForAudio

channelsAttributeForAudio?: ChannelsAttributeForAudio

Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag

Memberof

HlsManifest

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional encodingId

encodingId?: string

The id of the encoding to create a default manifest for (required)

+

Optional encodingId

encodingId?: string

The id of the encoding to create a default manifest for (required)

Memberof

HlsManifestDefault

-

Optional hlsMasterPlaylistVersion

hlsMasterPlaylistVersion?: HlsVersion

If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version

+

Optional hlsMasterPlaylistVersion

hlsMasterPlaylistVersion?: HlsVersion

If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version

Memberof

HlsManifest

-

Optional hlsMediaPlaylistVersion

hlsMediaPlaylistVersion?: HlsVersion

If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version

+

Optional hlsMediaPlaylistVersion

hlsMediaPlaylistVersion?: HlsVersion

If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version

Memberof

HlsManifest

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional manifestName

manifestName?: string

The filename of your manifest. If this is not set, the name is used as output file name. Either one of name or manifestName is required. Be aware that spaces will be replaced with underlines (_) on the output.

+

Optional manifestName

manifestName?: string

The filename of your manifest. If this is not set, the name is used as output file name. Either one of name or manifestName is required. Be aware that spaces will be replaced with underlines (_) on the output.

Memberof

HlsManifest

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

+

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

Memberof

Manifest

-

Optional status

status?: Status

Current status

+

Optional status

status?: Status

Current status

Memberof

Manifest

-

Optional targetDurationRoundingMode

targetDurationRoundingMode?: HlsTargetDurationRoundingMode

The rounding applied to target duration. Two possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer, or UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.

+

Optional targetDurationRoundingMode

targetDurationRoundingMode?: HlsTargetDurationRoundingMode

The rounding applied to target duration. Two possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer, or UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.

Memberof

HlsManifest

-

Optional type

type?: ManifestType

Memberof

Manifest

-

Optional version

version?: V1

Currently not in use

+

Optional type

type?: ManifestType

Memberof

Manifest

+

Optional version

version?: V1

Currently not in use

Memberof

HlsManifestDefault

-

Settings

Member Visibility

Theme

On This Page

constructorchannelsAttributeForAudiocreatedAtcustomDatadescriptionencodingIdhlsMasterPlaylistVersionhlsMediaPlaylistVersionidmanifestNamemodifiedAtnameoutputsstatustargetDurationRoundingModetypeversion
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorchannelsAttributeForAudiocreatedAtcustomDatadescriptionencodingIdhlsMasterPlaylistVersionhlsMediaPlaylistVersionidmanifestNamemodifiedAtnameoutputsstatustargetDurationRoundingModetypeversion
\ No newline at end of file diff --git a/docs/classes/HttpInput.html b/docs/classes/HttpInput.html index 04e6d2f28..e1296ea0e 100644 --- a/docs/classes/HttpInput.html +++ b/docs/classes/HttpInput.html @@ -1,5 +1,5 @@ HttpInput | @bitmovin/api-sdk

Class HttpInput

Export

HttpInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -13,26 +13,26 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Host Url or IP of the HTTP server (required)

+

Optional host

host?: string

Host Url or IP of the HTTP server (required)

Memberof

HttpInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional password

password?: string

Basic Auth Password, if required

+

Optional password

password?: string

Basic Auth Password, if required

Memberof

HttpInput

-

Optional port

port?: number

Custom Port

+

Optional port

port?: number

Custom Port

Memberof

HttpInput

-

Readonly type

type: InputType = InputType.HTTP

Discriminator property for Input

+

Readonly type

type: InputType = InputType.HTTP

Discriminator property for Input

Memberof

HttpInput

-

Optional username

username?: string

Basic Auth Username, if required

+

Optional username

username?: string

Basic Auth Username, if required

Memberof

HttpInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepasswordporttypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepasswordporttypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/HttpsInput.html b/docs/classes/HttpsInput.html index e34a0b0b4..f5ff15bf8 100644 --- a/docs/classes/HttpsInput.html +++ b/docs/classes/HttpsInput.html @@ -1,5 +1,5 @@ HttpsInput | @bitmovin/api-sdk

Class HttpsInput

Export

HttpsInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -13,26 +13,26 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Host Url or IP of the HTTP server (required)

+

Optional host

host?: string

Host Url or IP of the HTTP server (required)

Memberof

HttpsInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional password

password?: string

Basic Auth Password, if required

+

Optional password

password?: string

Basic Auth Password, if required

Memberof

HttpsInput

-

Optional port

port?: number

Custom Port

+

Optional port

port?: number

Custom Port

Memberof

HttpsInput

-

Readonly type

type: InputType = InputType.HTTPS

Discriminator property for Input

+

Readonly type

type: InputType = InputType.HTTPS

Discriminator property for Input

Memberof

HttpsInput

-

Optional username

username?: string

Basic Auth Username, if required

+

Optional username

username?: string

Basic Auth Username, if required

Memberof

HttpsInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepasswordporttypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepasswordporttypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/IFramePlaylist.html b/docs/classes/IFramePlaylist.html index 6e6c853c1..ae6ce0c29 100644 --- a/docs/classes/IFramePlaylist.html +++ b/docs/classes/IFramePlaylist.html @@ -1,5 +1,5 @@ IFramePlaylist | @bitmovin/api-sdk

Class IFramePlaylist

Export

IFramePlaylist

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -7,18 +7,18 @@ id? modifiedAt? name? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional filename

filename?: string

The filename of your I-frame playlist (required)

+

Optional filename

filename?: string

The filename of your I-frame playlist (required)

Memberof

IFramePlaylist

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionfilenameidmodifiedAtname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionfilenameidmodifiedAtname
\ No newline at end of file diff --git a/docs/classes/Id3Tag.html b/docs/classes/Id3Tag.html index 4a9b9841e..c78380661 100644 --- a/docs/classes/Id3Tag.html +++ b/docs/classes/Id3Tag.html @@ -1,5 +1,5 @@ Id3Tag | @bitmovin/api-sdk

Class Id3Tag

Export

Id3Tag

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -11,21 +11,21 @@ time? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional frame

frame?: number

Frame number at which the Tag should be inserted

+

Optional frame

frame?: number

Frame number at which the Tag should be inserted

Memberof

Id3Tag

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional positionMode

positionMode?: Id3TagPositionMode

Memberof

Id3Tag

-

Optional time

time?: number

Time in seconds where the Tag should be inserted

+

Optional positionMode

positionMode?: Id3TagPositionMode

Memberof

Id3Tag

+

Optional time

time?: number

Time in seconds where the Tag should be inserted

Memberof

Id3Tag

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    FRAME_ID: string;
    PLAIN_TEXT: string;
    RAW: string;
} = ...

Type declaration

  • FRAME_ID: string
  • PLAIN_TEXT: string
  • RAW: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionframeidmodifiedAtnamepositionModetime_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    FRAME_ID: string;
    PLAIN_TEXT: string;
    RAW: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionframeidmodifiedAtnamepositionModetime_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Ignoring.html b/docs/classes/Ignoring.html index e430753b2..6f26ac8e2 100644 --- a/docs/classes/Ignoring.html +++ b/docs/classes/Ignoring.html @@ -1,8 +1,8 @@ Ignoring | @bitmovin/api-sdk

Class Ignoring

Export

Ignoring

-

Constructors

constructor +

Constructors

constructor

Properties

ignoredBy? ignoredByDescription? -

Constructors

constructor

Properties

Optional ignoredBy

ignoredBy?: CONDITION

Memberof

Ignoring

-

Optional ignoredByDescription

ignoredByDescription?: string

Describes why ignoredBy has been set to its current value.

+

Constructors

constructor

Properties

Optional ignoredBy

ignoredBy?: CONDITION

Memberof

Ignoring

+

Optional ignoredByDescription

ignoredByDescription?: string

Describes why ignoredBy has been set to its current value.

Memberof

Ignoring

-

Settings

Member Visibility

Theme

On This Page

constructorignoredByignoredByDescription
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorignoredByignoredByDescription
\ No newline at end of file diff --git a/docs/classes/ImageAdaptationSet.html b/docs/classes/ImageAdaptationSet.html index c4d09fff0..eb678a2dc 100644 --- a/docs/classes/ImageAdaptationSet.html +++ b/docs/classes/ImageAdaptationSet.html @@ -1,5 +1,5 @@ ImageAdaptationSet | @bitmovin/api-sdk

Class ImageAdaptationSet

Export

ImageAdaptationSet

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessibilities? customAttributes? id? @@ -8,16 +8,16 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

+

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

Memberof

AdaptationSet

-

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

+

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

Memberof

AdaptationSet

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional labels

labels?: Label[]

List of labels

+

Optional labels

labels?: Label[]

List of labels

Memberof

AdaptationSet

-

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

+

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

Memberof

AdaptationSet

-

Readonly type

type: AdaptationSetType = AdaptationSetType.IMAGE

Discriminator property for AdaptationSet

+

Readonly type

type: AdaptationSetType = AdaptationSetType.IMAGE

Discriminator property for AdaptationSet

Memberof

ImageAdaptationSet

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

  • AUDIO: string
  • IMAGE: string
  • SUBTITLE: string
  • VIDEO: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelsrolestype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelsrolestype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ImscConfiguration.html b/docs/classes/ImscConfiguration.html index 1bbc81619..84c5fce6e 100644 --- a/docs/classes/ImscConfiguration.html +++ b/docs/classes/ImscConfiguration.html @@ -1,5 +1,5 @@ ImscConfiguration | @bitmovin/api-sdk

Class ImscConfiguration

Export

ImscConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -10,19 +10,19 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional styling

styling?: ImscStyling

Memberof

ImscConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.IMSC

Discriminator property for CodecConfiguration

+

Optional styling

styling?: ImscStyling

Memberof

ImscConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.IMSC

Discriminator property for CodecConfiguration

Memberof

ImscConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamestylingtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamestylingtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ImscStyling.html b/docs/classes/ImscStyling.html index b4c7ee742..8755e5c38 100644 --- a/docs/classes/ImscStyling.html +++ b/docs/classes/ImscStyling.html @@ -1,5 +1,5 @@ ImscStyling | @bitmovin/api-sdk

Class ImscStyling

Export

ImscStyling

-

Constructors

constructor +

Constructors

constructor

Properties

mode? -

Constructors

constructor

Properties

Optional mode

mode?: ImscStylingMode

Memberof

ImscStyling

-

Settings

Member Visibility

Theme

On This Page

constructormode
\ No newline at end of file +

Constructors

constructor

Properties

Optional mode

mode?: ImscStylingMode

Memberof

ImscStyling

+

Settings

Member Visibility

Theme

On This Page

constructormode
\ No newline at end of file diff --git a/docs/classes/InfrastructureSettings.html b/docs/classes/InfrastructureSettings.html index b6dabb035..9ad6c40cf 100644 --- a/docs/classes/InfrastructureSettings.html +++ b/docs/classes/InfrastructureSettings.html @@ -1,8 +1,8 @@ InfrastructureSettings | @bitmovin/api-sdk

Class InfrastructureSettings

Export

InfrastructureSettings

-

Constructors

constructor +

Constructors

constructor

Properties

cloudRegion? infrastructureId? -

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: CloudRegion

Memberof

InfrastructureSettings

-

Optional infrastructureId

infrastructureId?: string

Id of a custom infrastructure, e.g., AWS Cloud Connect

+

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: CloudRegion

Memberof

InfrastructureSettings

+

Optional infrastructureId

infrastructureId?: string

Id of a custom infrastructure, e.g., AWS Cloud Connect

Memberof

InfrastructureSettings

-

Settings

Member Visibility

Theme

On This Page

constructorcloudRegioninfrastructureId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcloudRegioninfrastructureId
\ No newline at end of file diff --git a/docs/classes/IngestInputStream.html b/docs/classes/IngestInputStream.html index 7cf823faf..73b93f7be 100644 --- a/docs/classes/IngestInputStream.html +++ b/docs/classes/IngestInputStream.html @@ -1,5 +1,5 @@ IngestInputStream | @bitmovin/api-sdk

Class IngestInputStream

Export

IngestInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

ID of an Input resource defining the input storage (required)

+

Optional inputId

inputId?: string

ID of an Input resource defining the input storage (required)

Memberof

IngestInputStream

-

Optional inputPath

inputPath?: string

Path to an input media file (required)

+

Optional inputPath

inputPath?: string

Path to an input media file (required)

Memberof

IngestInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional position

position?: number

Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.

+

Optional position

position?: number

Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.

Memberof

IngestInputStream

-

Optional selectionMode

selectionMode?: StreamSelectionMode

Specifies the strategy for selecting a stream from the input file

+

Optional selectionMode

selectionMode?: StreamSelectionMode

Specifies the strategy for selecting a stream from the input file

Memberof

IngestInputStream

-

Readonly type

type: InputStreamType = InputStreamType.INGEST

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.INGEST

Discriminator property for InputStream

Memberof

IngestInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnamepositionselectionModetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputIdinputPathmodifiedAtnamepositionselectionModetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Input.html b/docs/classes/Input.html index 81b1fee73..471515ca9 100644 --- a/docs/classes/Input.html +++ b/docs/classes/Input.html @@ -1,5 +1,5 @@ Input | @bitmovin/api-sdk

Class Input

Export

Input

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,16 +8,16 @@ name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/InputFactor.html b/docs/classes/InputFactor.html index bf0b6af1b..8c014b350 100644 --- a/docs/classes/InputFactor.html +++ b/docs/classes/InputFactor.html @@ -1,7 +1,7 @@ InputFactor | @bitmovin/api-sdk

Class InputFactor

Export

InputFactor

-

Constructors

constructor +

Constructors

constructor

Properties

bitrate? codec? -

Constructors

constructor

Properties

Optional bitrate

bitrate?: InputFactorBitrate

Memberof

InputFactor

-

Optional codec

codec?: InputFactorCodec

Memberof

InputFactor

-

Settings

Member Visibility

Theme

On This Page

constructorbitratecodec
\ No newline at end of file +

Constructors

constructor

Properties

Optional bitrate

bitrate?: InputFactorBitrate

Memberof

InputFactor

+

Optional codec

codec?: InputFactorCodec

Memberof

InputFactor

+

Settings

Member Visibility

Theme

On This Page

constructorbitratecodec
\ No newline at end of file diff --git a/docs/classes/InputFactorBitrate.html b/docs/classes/InputFactorBitrate.html index 6d28d2006..716983571 100644 --- a/docs/classes/InputFactorBitrate.html +++ b/docs/classes/InputFactorBitrate.html @@ -1,7 +1,7 @@ InputFactorBitrate | @bitmovin/api-sdk

Class InputFactorBitrate

Export

InputFactorBitrate

-

Constructors

constructor +

Constructors

constructor

Properties

factor? value? -

Constructors

constructor

Properties

Optional factor

factor?: number

Memberof

InputFactorBitrate

-

Optional value

value?: number

Memberof

InputFactorBitrate

-

Settings

Member Visibility

Theme

On This Page

constructorfactorvalue
\ No newline at end of file +

Constructors

constructor

Properties

Optional factor

factor?: number

Memberof

InputFactorBitrate

+

Optional value

value?: number

Memberof

InputFactorBitrate

+

Settings

Member Visibility

Theme

On This Page

constructorfactorvalue
\ No newline at end of file diff --git a/docs/classes/InputFactorCodec.html b/docs/classes/InputFactorCodec.html index 0caed9df4..cfd5875f8 100644 --- a/docs/classes/InputFactorCodec.html +++ b/docs/classes/InputFactorCodec.html @@ -1,7 +1,7 @@ InputFactorCodec | @bitmovin/api-sdk

Class InputFactorCodec

Export

InputFactorCodec

-

Constructors

constructor +

Constructors

constructor

Properties

factor? value? -

Constructors

constructor

Properties

Optional factor

factor?: number

Memberof

InputFactorCodec

-

Optional value

value?: string

Memberof

InputFactorCodec

-

Settings

Member Visibility

Theme

On This Page

constructorfactorvalue
\ No newline at end of file +

Constructors

constructor

Properties

Optional factor

factor?: number

Memberof

InputFactorCodec

+

Optional value

value?: string

Memberof

InputFactorCodec

+

Settings

Member Visibility

Theme

On This Page

constructorfactorvalue
\ No newline at end of file diff --git a/docs/classes/InputPath.html b/docs/classes/InputPath.html index 04e053efa..3850fea4b 100644 --- a/docs/classes/InputPath.html +++ b/docs/classes/InputPath.html @@ -1,9 +1,9 @@ InputPath | @bitmovin/api-sdk

Class InputPath

Export

InputPath

-

Constructors

constructor +

Constructors

constructor

Properties

inputId? inputPath? -

Constructors

constructor

Properties

Optional inputId

inputId?: string

Id of input (required)

+

Constructors

constructor

Properties

Optional inputId

inputId?: string

Id of input (required)

Memberof

InputPath

-

Optional inputPath

inputPath?: string

Path to media file (required)

+

Optional inputPath

inputPath?: string

Path to media file (required)

Memberof

InputPath

-

Settings

Member Visibility

Theme

On This Page

constructorinputIdinputPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorinputIdinputPath
\ No newline at end of file diff --git a/docs/classes/InputStream.html b/docs/classes/InputStream.html index deeff0472..f3af481d5 100644 --- a/docs/classes/InputStream.html +++ b/docs/classes/InputStream.html @@ -1,5 +1,5 @@ InputStream | @bitmovin/api-sdk

Class InputStream

Export

InputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,16 +8,16 @@ name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/InputStreamTypeResponse.html b/docs/classes/InputStreamTypeResponse.html index f1d5f468b..d4136ab7c 100644 --- a/docs/classes/InputStreamTypeResponse.html +++ b/docs/classes/InputStreamTypeResponse.html @@ -1,6 +1,6 @@ InputStreamTypeResponse | @bitmovin/api-sdk

Class InputStreamTypeResponse

Export

InputStreamTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: InputStreamType

The type of the input stream

+

Constructors

constructor

Properties

Optional type

type?: InputStreamType

The type of the input stream

Memberof

InputStreamTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/InputTypeResponse.html b/docs/classes/InputTypeResponse.html index b6029e9fc..d68543c6a 100644 --- a/docs/classes/InputTypeResponse.html +++ b/docs/classes/InputTypeResponse.html @@ -1,6 +1,6 @@ InputTypeResponse | @bitmovin/api-sdk

Class InputTypeResponse

Export

InputTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: InputType

The type of the input

+

Constructors

constructor

Properties

Optional type

type?: InputType

The type of the input

Memberof

InputTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/InsertableContent.html b/docs/classes/InsertableContent.html index b367d37c0..0cb5450ab 100644 --- a/docs/classes/InsertableContent.html +++ b/docs/classes/InsertableContent.html @@ -1,5 +1,5 @@ InsertableContent | @bitmovin/api-sdk

Class InsertableContent

Export

InsertableContent

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,20 +8,20 @@ modifiedAt? name? status? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputs

inputs?: InsertableContentInput[]

Either a list of movie files to be inserted in the live stream or a single image file. The movie files must have a video stream at stream position 0, which matches the codec, resolution and framerate of the livestream. The number of audio streams must also be the same and they have to match the sample format, number of channels and sample rate of the audio streams of the livestream. Supported image formats are: .Y.U.V, Alias PIX, animated GIF, APNG, BMP, DPX, FITS, JPEG, JPEG 2000, JPEG-LS, PAM, PBM, PCX, PGM, PGMYUV, PNG, PPM, SGI, Sun Rasterfile, TIFF, Truevision Targa, WebP, XBM, XFace, XPM, XWD

+

Optional inputs

inputs?: InsertableContentInput[]

Either a list of movie files to be inserted in the live stream or a single image file. The movie files must have a video stream at stream position 0, which matches the codec, resolution and framerate of the livestream. The number of audio streams must also be the same and they have to match the sample format, number of channels and sample rate of the audio streams of the livestream. Supported image formats are: .Y.U.V, Alias PIX, animated GIF, APNG, BMP, DPX, FITS, JPEG, JPEG 2000, JPEG-LS, PAM, PBM, PCX, PGM, PGMYUV, PNG, PPM, SGI, Sun Rasterfile, TIFF, Truevision Targa, WebP, XBM, XFace, XPM, XWD

Memberof

InsertableContent

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional status

status?: InsertableContentStatus

Status of the insertable content.

+

Optional status

status?: InsertableContentStatus

Status of the insertable content.

Memberof

InsertableContent

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputsmodifiedAtnamestatus
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputsmodifiedAtnamestatus
\ No newline at end of file diff --git a/docs/classes/InsertableContentInput.html b/docs/classes/InsertableContentInput.html index a19497f2b..51f339086 100644 --- a/docs/classes/InsertableContentInput.html +++ b/docs/classes/InsertableContentInput.html @@ -1,12 +1,12 @@ InsertableContentInput | @bitmovin/api-sdk

Class InsertableContentInput

Export

InsertableContentInput

-

Constructors

constructor +

Constructors

constructor

Properties

description? inputId? inputPath? -

Constructors

constructor

Properties

Optional description

description?: string

Description of this input

+

Constructors

constructor

Properties

Optional description

description?: string

Description of this input

Memberof

InsertableContentInput

-

Optional inputId

inputId?: string

Id of the input hosting the video file (required)

+

Optional inputId

inputId?: string

Id of the input hosting the video file (required)

Memberof

InsertableContentInput

-

Optional inputPath

inputPath?: string

Path to the file on the input (required)

+

Optional inputPath

inputPath?: string

Path to the file on the input (required)

Memberof

InsertableContentInput

-

Settings

Member Visibility

Theme

On This Page

constructordescriptioninputIdinputPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordescriptioninputIdinputPath
\ No newline at end of file diff --git a/docs/classes/InterlaceFilter.html b/docs/classes/InterlaceFilter.html index 8052b7f96..227f691d1 100644 --- a/docs/classes/InterlaceFilter.html +++ b/docs/classes/InterlaceFilter.html @@ -1,5 +1,5 @@ InterlaceFilter | @bitmovin/api-sdk

Class InterlaceFilter

Export

InterlaceFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -11,20 +11,20 @@ verticalLowPassFilteringMode? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional mode

mode?: InterlaceMode

Memberof

InterlaceFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional mode

mode?: InterlaceMode

Memberof

InterlaceFilter

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: FilterType = FilterType.INTERLACE

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.INTERLACE

Discriminator property for Filter

Memberof

InterlaceFilter

-

Optional verticalLowPassFilteringMode

verticalLowPassFilteringMode?: VerticalLowPassFilteringMode

Memberof

InterlaceFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodemodifiedAtnametypeverticalLowPassFilteringMode_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional verticalLowPassFilteringMode

verticalLowPassFilteringMode?: VerticalLowPassFilteringMode

Memberof

InterlaceFilter

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodemodifiedAtnametypeverticalLowPassFilteringMode_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Invitation.html b/docs/classes/Invitation.html index 91f008dae..e1adc8ab4 100644 --- a/docs/classes/Invitation.html +++ b/docs/classes/Invitation.html @@ -1,5 +1,5 @@ Invitation | @bitmovin/api-sdk

Class Invitation

Export

Invitation

-

Constructors

constructor +

Constructors

constructor

Properties

company? createdAt? email? @@ -9,15 +9,15 @@ lastName? phone? status? -

Constructors

constructor

Properties

Optional company

company?: string

Memberof

Invitation

-

Optional createdAt

createdAt?: Date

Creation date of the invitation in UTC format

+

Constructors

constructor

Properties

Optional company

company?: string

Memberof

Invitation

+

Optional createdAt

createdAt?: Date

Creation date of the invitation in UTC format

Memberof

Invitation

-

Optional email

email?: string

Email address of the tenant. (required)

+

Optional email

email?: string

Email address of the tenant. (required)

Memberof

Invitation

-

Optional firstName

firstName?: string

Memberof

Invitation

-

Optional id

id?: string

Memberof

Invitation

-

Optional jobTitle

jobTitle?: string

Memberof

Invitation

-

Optional lastName

lastName?: string

Memberof

Invitation

-

Optional phone

phone?: string

Memberof

Invitation

-

Optional status

status?: InvitationStatus

Memberof

Invitation

-

Settings

Member Visibility

Theme

On This Page

constructorcompanycreatedAtemailfirstNameidjobTitlelastNamephonestatus
\ No newline at end of file +

Optional firstName

firstName?: string

Memberof

Invitation

+

Optional id

id?: string

Memberof

Invitation

+

Optional jobTitle

jobTitle?: string

Memberof

Invitation

+

Optional lastName

lastName?: string

Memberof

Invitation

+

Optional phone

phone?: string

Memberof

Invitation

+

Optional status

status?: InvitationStatus

Memberof

Invitation

+

Settings

Member Visibility

Theme

On This Page

constructorcompanycreatedAtemailfirstNameidjobTitlelastNamephonestatus
\ No newline at end of file diff --git a/docs/classes/Keyframe.html b/docs/classes/Keyframe.html index 3322ae8fc..c4153de18 100644 --- a/docs/classes/Keyframe.html +++ b/docs/classes/Keyframe.html @@ -1,5 +1,5 @@ Keyframe | @bitmovin/api-sdk

Class Keyframe

Export

Keyframe

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,20 +8,20 @@ name? segmentCut? time? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional segmentCut

segmentCut?: boolean

Instructs the encoder to cut the segment at this position

+

Optional segmentCut

segmentCut?: boolean

Instructs the encoder to cut the segment at this position

Memberof

Keyframe

-

Optional time

time?: number

Time in seconds where the keyframe should be inserted (required)

+

Optional time

time?: number

Time in seconds where the keyframe should be inserted (required)

Memberof

Keyframe

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamesegmentCuttime
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamesegmentCuttime
\ No newline at end of file diff --git a/docs/classes/Label.html b/docs/classes/Label.html index 14d8b50cc..a8d4d4f3c 100644 --- a/docs/classes/Label.html +++ b/docs/classes/Label.html @@ -1,12 +1,12 @@ Label | @bitmovin/api-sdk

Class Label

Export

Label

-

Constructors

constructor +

Constructors

constructor

Properties

id? lang? value? -

Constructors

constructor

Properties

Optional id

id?: number

Identifier of the label.

+

Constructors

constructor

Properties

Optional id

id?: number

Identifier of the label.

Memberof

Label

-

Optional lang

lang?: string

Specifies the language of the label.

+

Optional lang

lang?: string

Specifies the language of the label.

Memberof

Label

-

Optional value

value?: string

Content of the label. (required)

+

Optional value

value?: string

Content of the label. (required)

Memberof

Label

-

Settings

Member Visibility

Theme

On This Page

constructoridlangvalue
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridlangvalue
\ No newline at end of file diff --git a/docs/classes/Link.html b/docs/classes/Link.html index 89c966097..510b985bc 100644 --- a/docs/classes/Link.html +++ b/docs/classes/Link.html @@ -1,9 +1,9 @@ Link | @bitmovin/api-sdk

Class Link

Export

Link

-

Constructors

constructor +

Constructors

constructor

Properties

href? title? -

Constructors

constructor

Properties

Optional href

href?: string

webpage target URL (required)

+

Constructors

constructor

Properties

Optional href

href?: string

webpage target URL (required)

Memberof

Link

-

Optional title

title?: string

Short description of the linked page

+

Optional title

title?: string

Short description of the linked page

Memberof

Link

-

Settings

Member Visibility

Theme

On This Page

constructorhreftitle
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorhreftitle
\ No newline at end of file diff --git a/docs/classes/LiveAutoShutdownConfiguration.html b/docs/classes/LiveAutoShutdownConfiguration.html index 1c419d4dd..cc01a891f 100644 --- a/docs/classes/LiveAutoShutdownConfiguration.html +++ b/docs/classes/LiveAutoShutdownConfiguration.html @@ -1,9 +1,9 @@ LiveAutoShutdownConfiguration | @bitmovin/api-sdk

Class LiveAutoShutdownConfiguration

Export

LiveAutoShutdownConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

bytesReadTimeoutSeconds? streamTimeoutMinutes? -

Constructors

constructor

Properties

Optional bytesReadTimeoutSeconds

bytesReadTimeoutSeconds?: number

Automatically shutdown the live stream if there is no input anymore for a predefined number of seconds.

+

Constructors

constructor

Properties

Optional bytesReadTimeoutSeconds

bytesReadTimeoutSeconds?: number

Automatically shutdown the live stream if there is no input anymore for a predefined number of seconds.

Memberof

LiveAutoShutdownConfiguration

-

Optional streamTimeoutMinutes

streamTimeoutMinutes?: number

Automatically shutdown the live stream after a predefined runtime in minutes.

+

Optional streamTimeoutMinutes

streamTimeoutMinutes?: number

Automatically shutdown the live stream after a predefined runtime in minutes.

Memberof

LiveAutoShutdownConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorbytesReadTimeoutSecondsstreamTimeoutMinutes
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbytesReadTimeoutSecondsstreamTimeoutMinutes
\ No newline at end of file diff --git a/docs/classes/LiveDashManifest.html b/docs/classes/LiveDashManifest.html index 8f3c45779..2826a20b7 100644 --- a/docs/classes/LiveDashManifest.html +++ b/docs/classes/LiveDashManifest.html @@ -1,21 +1,21 @@ LiveDashManifest | @bitmovin/api-sdk

Class LiveDashManifest

Export

LiveDashManifest

-

Constructors

constructor +

Constructors

constructor

Properties

availabilityStartTimeMode? liveEdgeOffset? manifestId? minimumUpdatePeriod? suggestedPresentationDelay? timeshift? -

Constructors

constructor

Properties

Optional availabilityStartTimeMode

availabilityStartTimeMode?: AvailabilityStartTimeMode

The mode to trigger the availabilityStartTime initialization.

+

Constructors

constructor

Properties

Optional availabilityStartTimeMode

availabilityStartTimeMode?: AvailabilityStartTimeMode

The mode to trigger the availabilityStartTime initialization.

Memberof

LiveDashManifest

-

Optional liveEdgeOffset

liveEdgeOffset?: number

Live edge offset in seconds

+

Optional liveEdgeOffset

liveEdgeOffset?: number

Live edge offset in seconds

Memberof

LiveDashManifest

-

Optional manifestId

manifestId?: string

Dash manifest id (required)

+

Optional manifestId

manifestId?: string

Dash manifest id (required)

Memberof

LiveDashManifest

-

Optional minimumUpdatePeriod

minimumUpdatePeriod?: number

The minimumUpdatePeriod to be set in the DASH manifest. If nothing is set, the segment duration will be set.

+

Optional minimumUpdatePeriod

minimumUpdatePeriod?: number

The minimumUpdatePeriod to be set in the DASH manifest. If nothing is set, the segment duration will be set.

Memberof

LiveDashManifest

-

Optional suggestedPresentationDelay

suggestedPresentationDelay?: number

The suggestedPresentationDelay to be set in the DASH manifest. If nothing is set, no value will be set.

+

Optional suggestedPresentationDelay

suggestedPresentationDelay?: number

The suggestedPresentationDelay to be set in the DASH manifest. If nothing is set, no value will be set.

Memberof

LiveDashManifest

-

Optional timeshift

timeshift?: number

Timeshift in seconds

+

Optional timeshift

timeshift?: number

Timeshift in seconds

Memberof

LiveDashManifest

-

Settings

Member Visibility

Theme

On This Page

constructoravailabilityStartTimeModeliveEdgeOffsetmanifestIdminimumUpdatePeriodsuggestedPresentationDelaytimeshift
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoravailabilityStartTimeModeliveEdgeOffsetmanifestIdminimumUpdatePeriodsuggestedPresentationDelaytimeshift
\ No newline at end of file diff --git a/docs/classes/LiveEncoding.html b/docs/classes/LiveEncoding.html index 993a99772..ede78734f 100644 --- a/docs/classes/LiveEncoding.html +++ b/docs/classes/LiveEncoding.html @@ -1,12 +1,12 @@ LiveEncoding | @bitmovin/api-sdk

Class LiveEncoding

Export

LiveEncoding

-

Constructors

constructor +

Constructors

constructor

Properties

application? encoderIp? streamKey? -

Constructors

constructor

Properties

Optional application

application?: string

This will indicate the application 'live'

+

Constructors

constructor

Properties

Optional application

application?: string

This will indicate the application 'live'

Memberof

LiveEncoding

-

Optional encoderIp

encoderIp?: string

IP address of the live encoder (required)

+

Optional encoderIp

encoderIp?: string

IP address of the live encoder (required)

Memberof

LiveEncoding

-

Optional streamKey

streamKey?: string

Stream key of the live encoder (required)

+

Optional streamKey

streamKey?: string

Stream key of the live encoder (required)

Memberof

LiveEncoding

-

Settings

Member Visibility

Theme

On This Page

constructorapplicationencoderIpstreamKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapplicationencoderIpstreamKey
\ No newline at end of file diff --git a/docs/classes/LiveEncodingOptionsStatistics.html b/docs/classes/LiveEncodingOptionsStatistics.html index 053c07e46..2b6642770 100644 --- a/docs/classes/LiveEncodingOptionsStatistics.html +++ b/docs/classes/LiveEncodingOptionsStatistics.html @@ -1,11 +1,11 @@ LiveEncodingOptionsStatistics | @bitmovin/api-sdk

Class LiveEncodingOptionsStatistics

Export

LiveEncodingOptionsStatistics

-

Constructors

constructor +

Constructors

constructor

Properties

encodingId? type? unitsUsed? -

Constructors

constructor

Properties

Optional encodingId

encodingId?: string

The ID of the encoding (required)

+

Constructors

constructor

Properties

Optional encodingId

encodingId?: string

The ID of the encoding (required)

Memberof

LiveEncodingOptionsStatistics

-

Optional type

type?: HD

Memberof

LiveEncodingOptionsStatistics

-

Optional unitsUsed

unitsUsed?: number

Live option units used (required)

+

Optional type

type?: HD

Memberof

LiveEncodingOptionsStatistics

+

Optional unitsUsed

unitsUsed?: number

Live option units used (required)

Memberof

LiveEncodingOptionsStatistics

-

Settings

Member Visibility

Theme

On This Page

constructorencodingIdtypeunitsUsed
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorencodingIdtypeunitsUsed
\ No newline at end of file diff --git a/docs/classes/LiveEncodingStats.html b/docs/classes/LiveEncodingStats.html index 80d0cfb55..ab1ab5420 100644 --- a/docs/classes/LiveEncodingStats.html +++ b/docs/classes/LiveEncodingStats.html @@ -1,11 +1,11 @@ LiveEncodingStats | @bitmovin/api-sdk

Class LiveEncodingStats

Export

LiveEncodingStats

-

Constructors

constructor +

Constructors

constructor

Properties

events? statistics? status? -

Constructors

constructor

Properties

Optional events

events?: LiveEncodingStatsEvent[]

List of events

+

Constructors

constructor

Properties

Optional events

events?: LiveEncodingStatsEvent[]

List of events

Memberof

LiveEncodingStats

-

Optional statistics

statistics?: StreamInfos[]

List of statistics

+

Optional statistics

statistics?: StreamInfos[]

List of statistics

Memberof

LiveEncodingStats

-

Optional status

status?: LiveEncodingStatus

Memberof

LiveEncodingStats

-

Settings

Member Visibility

Theme

On This Page

constructoreventsstatisticsstatus
\ No newline at end of file +

Optional status

status?: LiveEncodingStatus

Memberof

LiveEncodingStats

+

Settings

Member Visibility

Theme

On This Page

constructoreventsstatisticsstatus
\ No newline at end of file diff --git a/docs/classes/LiveEncodingStatsEvent.html b/docs/classes/LiveEncodingStatsEvent.html index fc0e4278e..9f01e2651 100644 --- a/docs/classes/LiveEncodingStatsEvent.html +++ b/docs/classes/LiveEncodingStatsEvent.html @@ -1,8 +1,8 @@ LiveEncodingStatsEvent | @bitmovin/api-sdk

Class LiveEncodingStatsEvent

Export

LiveEncodingStatsEvent

-

Constructors

constructor +

Constructors

constructor

Properties

details? time? -

Constructors

constructor

Properties

Optional details

details?: LiveEncodingStatsEventDetails

Memberof

LiveEncodingStatsEvent

-

Optional time

time?: Date

Timestamp of the event, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)

+

Constructors

constructor

Properties

Optional details

details?: LiveEncodingStatsEventDetails

Memberof

LiveEncodingStatsEvent

+

Optional time

time?: Date

Timestamp of the event, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)

Memberof

LiveEncodingStatsEvent

-

Settings

Member Visibility

Theme

On This Page

constructordetailstime
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordetailstime
\ No newline at end of file diff --git a/docs/classes/LiveEncodingStatsEventDetails.html b/docs/classes/LiveEncodingStatsEventDetails.html index 3f22650ad..9c88a9249 100644 --- a/docs/classes/LiveEncodingStatsEventDetails.html +++ b/docs/classes/LiveEncodingStatsEventDetails.html @@ -1,5 +1,5 @@ LiveEncodingStatsEventDetails | @bitmovin/api-sdk

Class LiveEncodingStatsEventDetails

Export

LiveEncodingStatsEventDetails

-

Constructors

constructor +

Constructors

constructor

Properties

eventType? -

Constructors

constructor

Properties

Optional eventType

eventType?: LiveEncodingEventName

Memberof

LiveEncodingStatsEventDetails

-

Settings

Member Visibility

Theme

On This Page

constructoreventType
\ No newline at end of file +

Constructors

constructor

Properties

Optional eventType

eventType?: LiveEncodingEventName

Memberof

LiveEncodingStatsEventDetails

+

Settings

Member Visibility

Theme

On This Page

constructoreventType
\ No newline at end of file diff --git a/docs/classes/LiveHlsManifest.html b/docs/classes/LiveHlsManifest.html index 43c85b410..87e986a5a 100644 --- a/docs/classes/LiveHlsManifest.html +++ b/docs/classes/LiveHlsManifest.html @@ -1,21 +1,21 @@ LiveHlsManifest | @bitmovin/api-sdk

Class LiveHlsManifest

Export

LiveHlsManifest

-

Constructors

constructor +

Constructors

constructor

Properties

adMarkerSettings? insertProgramDateTime? liveEdgeOffset? manifestId? programDateTimeSettings? timeshift? -

Constructors

constructor

Properties

Optional adMarkerSettings

adMarkerSettings?: HlsManifestAdMarkerSettings

Configuration for tags related to ad markers (e.g. Scte35)

+

Constructors

constructor

Properties

Optional adMarkerSettings

adMarkerSettings?: HlsManifestAdMarkerSettings

Configuration for tags related to ad markers (e.g. Scte35)

Memberof

LiveHlsManifest

-

Optional insertProgramDateTime

insertProgramDateTime?: boolean

Specifies if the EXT-X-PROGRAM-DATETIME tag will be included

+

Optional insertProgramDateTime

insertProgramDateTime?: boolean

Specifies if the EXT-X-PROGRAM-DATETIME tag will be included

Memberof

LiveHlsManifest

-

Optional liveEdgeOffset

liveEdgeOffset?: number

Live edge offset in seconds

+

Optional liveEdgeOffset

liveEdgeOffset?: number

Live edge offset in seconds

Memberof

LiveHlsManifest

-

Optional manifestId

manifestId?: string

HLS manifest id (required)

+

Optional manifestId

manifestId?: string

HLS manifest id (required)

Memberof

LiveHlsManifest

-

Optional programDateTimeSettings

programDateTimeSettings?: ProgramDateTimeSettings

Configuration for the EXT-X-PROGRAM-DATETIME tag

+

Optional programDateTimeSettings

programDateTimeSettings?: ProgramDateTimeSettings

Configuration for the EXT-X-PROGRAM-DATETIME tag

Memberof

LiveHlsManifest

-

Optional timeshift

timeshift?: number

Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.

+

Optional timeshift

timeshift?: number

Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.

Memberof

LiveHlsManifest

-

Settings

Member Visibility

Theme

On This Page

constructoradMarkerSettingsinsertProgramDateTimeliveEdgeOffsetmanifestIdprogramDateTimeSettingstimeshift
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoradMarkerSettingsinsertProgramDateTimeliveEdgeOffsetmanifestIdprogramDateTimeSettingstimeshift
\ No newline at end of file diff --git a/docs/classes/LiveMediaIngestOutput.html b/docs/classes/LiveMediaIngestOutput.html index 7fd5fa486..477547807 100644 --- a/docs/classes/LiveMediaIngestOutput.html +++ b/docs/classes/LiveMediaIngestOutput.html @@ -1,6 +1,6 @@ LiveMediaIngestOutput | @bitmovin/api-sdk

Class LiveMediaIngestOutput

Live Media and Metadata Ingest Protocol. See https://tools.ietf.org/html/draft-mekuria-mmediaingest-01.

Export

LiveMediaIngestOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -12,22 +12,22 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional publishingPoint

publishingPoint?: string

URL specifying the publishing point for the output. Can use either http or https. (required)

+

Optional publishingPoint

publishingPoint?: string

URL specifying the publishing point for the output. Can use either http or https. (required)

Memberof

LiveMediaIngestOutput

-

Readonly type

type: OutputType = OutputType.LIVE_MEDIA_INGEST

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.LIVE_MEDIA_INGEST

Discriminator property for Output

Memberof

LiveMediaIngestOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionidmodifiedAtnamepublishingPointtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionidmodifiedAtnamepublishingPointtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/LiveOptionsBreakdownEntry.html b/docs/classes/LiveOptionsBreakdownEntry.html index 0198069fd..0b7a59b8e 100644 --- a/docs/classes/LiveOptionsBreakdownEntry.html +++ b/docs/classes/LiveOptionsBreakdownEntry.html @@ -1,8 +1,8 @@ LiveOptionsBreakdownEntry | @bitmovin/api-sdk

Class LiveOptionsBreakdownEntry

Export

LiveOptionsBreakdownEntry

-

Constructors

constructor +

Constructors

constructor

Properties

date? hd? -

Constructors

constructor

Properties

Optional date

date?: Date

Date, format: yyyy-MM-dd (required)

+

Constructors

constructor

Properties

Optional date

date?: Date

Date, format: yyyy-MM-dd (required)

Memberof

LiveOptionsBreakdownEntry

-

Optional hd

hd?: LiveOptionsEntry

Memberof

LiveOptionsBreakdownEntry

-

Settings

Member Visibility

Theme

On This Page

constructordatehd
\ No newline at end of file +

Optional hd

hd?: LiveOptionsEntry

Memberof

LiveOptionsBreakdownEntry

+

Settings

Member Visibility

Theme

On This Page

constructordatehd
\ No newline at end of file diff --git a/docs/classes/LiveOptionsEntry.html b/docs/classes/LiveOptionsEntry.html index 8dbecff00..a90a04cab 100644 --- a/docs/classes/LiveOptionsEntry.html +++ b/docs/classes/LiveOptionsEntry.html @@ -1,6 +1,6 @@ LiveOptionsEntry | @bitmovin/api-sdk

Class LiveOptionsEntry

Export

LiveOptionsEntry

-

Constructors

constructor +

Constructors

constructor

Properties

unitsUsed? -

Constructors

constructor

Properties

Optional unitsUsed

unitsUsed?: number

Live option units used (required)

+

Constructors

constructor

Properties

Optional unitsUsed

unitsUsed?: number

Live option units used (required)

Memberof

LiveOptionsEntry

-

Settings

Member Visibility

Theme

On This Page

constructorunitsUsed
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorunitsUsed
\ No newline at end of file diff --git a/docs/classes/LiveOptionsStatistics.html b/docs/classes/LiveOptionsStatistics.html index 9a9e3ec3a..23e939a05 100644 --- a/docs/classes/LiveOptionsStatistics.html +++ b/docs/classes/LiveOptionsStatistics.html @@ -1,8 +1,8 @@ LiveOptionsStatistics | @bitmovin/api-sdk

Class LiveOptionsStatistics

Export

LiveOptionsStatistics

-

Constructors

constructor +

Constructors

constructor

Properties

breakdown? summary? -

Constructors

constructor

Properties

Optional breakdown

breakdown?: LiveOptionsBreakdownEntry[]

Live options statistics aggregated per day (required)

+

Constructors

constructor

Properties

Optional breakdown

breakdown?: LiveOptionsBreakdownEntry[]

Live options statistics aggregated per day (required)

Memberof

LiveOptionsStatistics

-

Optional summary

summary?: LiveOptionsSummary

Memberof

LiveOptionsStatistics

-

Settings

Member Visibility

Theme

On This Page

constructorbreakdownsummary
\ No newline at end of file +

Optional summary

summary?: LiveOptionsSummary

Memberof

LiveOptionsStatistics

+

Settings

Member Visibility

Theme

On This Page

constructorbreakdownsummary
\ No newline at end of file diff --git a/docs/classes/LiveOptionsSummary.html b/docs/classes/LiveOptionsSummary.html index 800d5699e..0a5dd0ee8 100644 --- a/docs/classes/LiveOptionsSummary.html +++ b/docs/classes/LiveOptionsSummary.html @@ -1,5 +1,5 @@ LiveOptionsSummary | @bitmovin/api-sdk

Class LiveOptionsSummary

Export

LiveOptionsSummary

-

Constructors

constructor +

Constructors

constructor

Properties

hd? -

Constructors

constructor

Properties

Optional hd

hd?: LiveOptionsEntry

Memberof

LiveOptionsSummary

-

Settings

Member Visibility

Theme

On This Page

constructorhd
\ No newline at end of file +

Constructors

constructor

Properties

Optional hd

hd?: LiveOptionsEntry

Memberof

LiveOptionsSummary

+

Settings

Member Visibility

Theme

On This Page

constructorhd
\ No newline at end of file diff --git a/docs/classes/LocalInput.html b/docs/classes/LocalInput.html index 641cfd8a9..d45088e44 100644 --- a/docs/classes/LocalInput.html +++ b/docs/classes/LocalInput.html @@ -1,5 +1,5 @@ LocalInput | @bitmovin/api-sdk

Class LocalInput

Export

LocalInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -10,20 +10,20 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional path

path?: string

Path to your local storage (required)

+

Optional path

path?: string

Path to your local storage (required)

Memberof

LocalInput

-

Readonly type

type: InputType = InputType.LOCAL

Discriminator property for Input

+

Readonly type

type: InputType = InputType.LOCAL

Discriminator property for Input

Memberof

LocalInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamepathtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamepathtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/LocalOutput.html b/docs/classes/LocalOutput.html index f0197bfe6..74c3b99f2 100644 --- a/docs/classes/LocalOutput.html +++ b/docs/classes/LocalOutput.html @@ -1,5 +1,5 @@ LocalOutput | @bitmovin/api-sdk

Class LocalOutput

Export

LocalOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -11,22 +11,22 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional path

path?: string

Path to your local storage (required)

+

Optional path

path?: string

Path to your local storage (required)

Memberof

LocalOutput

-

Readonly type

type: OutputType = OutputType.LOCAL

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.LOCAL

Discriminator property for Output

Memberof

LocalOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionidmodifiedAtnamepathtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionidmodifiedAtnamepathtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Manifest.html b/docs/classes/Manifest.html index 8334b6b04..e87b7dd42 100644 --- a/docs/classes/Manifest.html +++ b/docs/classes/Manifest.html @@ -1,5 +1,5 @@ Manifest | @bitmovin/api-sdk

Class Manifest

Export

Manifest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,21 +9,21 @@ outputs? status? type? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

+

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

Memberof

Manifest

-

Optional status

status?: Status

Current status

+

Optional status

status?: Status

Current status

Memberof

Manifest

-

Optional type

type?: ManifestType

Memberof

Manifest

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameoutputsstatustype
\ No newline at end of file +

Optional type

type?: ManifestType

Memberof

Manifest

+

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnameoutputsstatustype
\ No newline at end of file diff --git a/docs/classes/ManifestResource.html b/docs/classes/ManifestResource.html index 6bf4e0bd3..8ead44a2b 100644 --- a/docs/classes/ManifestResource.html +++ b/docs/classes/ManifestResource.html @@ -1,6 +1,6 @@ ManifestResource | @bitmovin/api-sdk

Class ManifestResource

Export

ManifestResource

-

Constructors

constructor +

Constructors

constructor

Properties

manifestId? -

Constructors

constructor

Properties

Optional manifestId

manifestId?: string

Id of the manifest resource (required)

+

Constructors

constructor

Properties

Optional manifestId

manifestId?: string

Id of the manifest resource (required)

Memberof

ManifestResource

-

Settings

Member Visibility

Theme

On This Page

constructormanifestId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructormanifestId
\ No newline at end of file diff --git a/docs/classes/ManifestTypeResponse.html b/docs/classes/ManifestTypeResponse.html index afa4eae89..77b69d5c6 100644 --- a/docs/classes/ManifestTypeResponse.html +++ b/docs/classes/ManifestTypeResponse.html @@ -1,6 +1,6 @@ ManifestTypeResponse | @bitmovin/api-sdk

Class ManifestTypeResponse

Export

ManifestTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: ManifestType

The type of the manifest

+

Constructors

constructor

Properties

Optional type

type?: ManifestType

The type of the manifest

Memberof

ManifestTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/MarlinDrm.html b/docs/classes/MarlinDrm.html index e3fb8d3b4..668b0451f 100644 --- a/docs/classes/MarlinDrm.html +++ b/docs/classes/MarlinDrm.html @@ -1,5 +1,5 @@ MarlinDrm | @bitmovin/api-sdk

Class MarlinDrm

Export

MarlinDrm

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,23 +12,23 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional key

key?: string

16 byte key in hex (32 characters) (required)

+

Optional key

key?: string

16 byte key in hex (32 characters) (required)

Memberof

MarlinDrm

-

Optional kid

kid?: string

16 byte key in hex (32 characters) (required)

+

Optional kid

kid?: string

16 byte key in hex (32 characters) (required)

Memberof

MarlinDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Readonly type

type: DrmType = DrmType.MARLIN

Discriminator property for Drm

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Readonly type

type: DrmType = DrmType.MARLIN

Discriminator property for Drm

Memberof

MarlinDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidkeykidmodifiedAtnameoutputstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidkeykidmodifiedAtnameoutputstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/MediaInfoTypeResponse.html b/docs/classes/MediaInfoTypeResponse.html index d5120c983..c083bf8af 100644 --- a/docs/classes/MediaInfoTypeResponse.html +++ b/docs/classes/MediaInfoTypeResponse.html @@ -1,6 +1,6 @@ MediaInfoTypeResponse | @bitmovin/api-sdk

Class MediaInfoTypeResponse

Export

MediaInfoTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: MediaInfoType

The type of the media-info

+

Constructors

constructor

Properties

Optional type

type?: MediaInfoType

The type of the media-info

Memberof

MediaInfoTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/MediaStream.html b/docs/classes/MediaStream.html index aa0d4b6dc..cf7c4d53d 100644 --- a/docs/classes/MediaStream.html +++ b/docs/classes/MediaStream.html @@ -1,15 +1,15 @@ MediaStream | @bitmovin/api-sdk

Class MediaStream

Export

MediaStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

codec? duration? id? position? -

Constructors

constructor

Properties

Optional codec

codec?: string

Codec of the stream

+

Constructors

constructor

Properties

Optional codec

codec?: string

Codec of the stream

Memberof

MediaStream

-

Optional duration

duration?: number

Duration of the stream in seconds

+

Optional duration

duration?: number

Duration of the stream in seconds

Memberof

MediaStream

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional position

position?: number

Position of the stream in the media, starting from 0.

+

Optional position

position?: number

Position of the stream in the media, starting from 0.

Memberof

MediaStream

-

Settings

Member Visibility

Theme

On This Page

constructorcodecdurationidposition
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcodecdurationidposition
\ No newline at end of file diff --git a/docs/classes/Message.html b/docs/classes/Message.html index d1a9276aa..041c69d3b 100644 --- a/docs/classes/Message.html +++ b/docs/classes/Message.html @@ -1,5 +1,5 @@ Message | @bitmovin/api-sdk

Class Message

Export

Message

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

date? field? id? @@ -7,18 +7,18 @@ more? text? type? -

Constructors

constructor

Properties

Optional date

date?: Date

Timestamp when the message occurred

+

Constructors

constructor

Properties

Optional date

date?: Date

Timestamp when the message occurred

Memberof

Message

-

Optional field

field?: string

Name of the field to which the message is referring to

+

Optional field

field?: string

Name of the field to which the message is referring to

Memberof

Message

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional links

links?: Link[]

collection of links to webpages containing further information on the topic

+

Optional links

links?: Link[]

collection of links to webpages containing further information on the topic

Memberof

Message

-

Optional more

more?: any

Service-specific information

+

Optional more

more?: any

Service-specific information

Memberof

Message

-

Optional text

text?: string

Message text (required)

+

Optional text

text?: string

Message text (required)

Memberof

Message

-

Optional type

type?: MessageType

Message type giving a hint on the importance of the message (log level) (required)

+

Optional type

type?: MessageType

Message type giving a hint on the importance of the message (log level) (required)

Memberof

Message

-

Settings

Member Visibility

Theme

On This Page

constructordatefieldidlinksmoretexttype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordatefieldidlinksmoretexttype
\ No newline at end of file diff --git a/docs/classes/MjpegVideoConfiguration.html b/docs/classes/MjpegVideoConfiguration.html index 77403ee76..02d21aa2c 100644 --- a/docs/classes/MjpegVideoConfiguration.html +++ b/docs/classes/MjpegVideoConfiguration.html @@ -1,5 +1,5 @@ MjpegVideoConfiguration | @bitmovin/api-sdk

Class MjpegVideoConfiguration

Export

MjpegVideoConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -14,27 +14,27 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional height

height?: number

Height of the encoded video

+

Optional height

height?: number

Height of the encoded video

Memberof

MjpegVideoConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional pixelFormat

pixelFormat?: PixelFormat

Memberof

MjpegVideoConfiguration

-

Optional qScale

qScale?: number

The quality scale parameter (required)

+

Optional pixelFormat

pixelFormat?: PixelFormat

Memberof

MjpegVideoConfiguration

+

Optional qScale

qScale?: number

The quality scale parameter (required)

Memberof

MjpegVideoConfiguration

-

Optional rate

rate?: number

Target frame rate of the encoded video! (required)

+

Optional rate

rate?: number

Target frame rate of the encoded video! (required)

Memberof

MjpegVideoConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.MJPEG

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.MJPEG

Discriminator property for CodecConfiguration

Memberof

MjpegVideoConfiguration

-

Optional width

width?: number

Width of the encoded video

+

Optional width

width?: number

Width of the encoded video

Memberof

MjpegVideoConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionheightidmodifiedAtnamepixelFormatqScaleratetypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionheightidmodifiedAtnamepixelFormatqScaleratetypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Mp2AudioConfiguration.html b/docs/classes/Mp2AudioConfiguration.html index d3842dc8f..b63c3f2ab 100644 --- a/docs/classes/Mp2AudioConfiguration.html +++ b/docs/classes/Mp2AudioConfiguration.html @@ -1,5 +1,5 @@ Mp2AudioConfiguration | @bitmovin/api-sdk

Class Mp2AudioConfiguration

Export

Mp2AudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: ChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: ChannelLayout

Channel layout of the audio codec configuration

Memberof

Mp2AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.MP2

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.MP2

Discriminator property for CodecConfiguration

Memberof

Mp2AudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Mp3AudioConfiguration.html b/docs/classes/Mp3AudioConfiguration.html index 278aac794..2fb2953e3 100644 --- a/docs/classes/Mp3AudioConfiguration.html +++ b/docs/classes/Mp3AudioConfiguration.html @@ -1,5 +1,5 @@ Mp3AudioConfiguration | @bitmovin/api-sdk

Class Mp3AudioConfiguration

Export

Mp3AudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: ChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: ChannelLayout

Channel layout of the audio codec configuration

Memberof

Mp3AudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.MP3

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.MP3

Discriminator property for CodecConfiguration

Memberof

Mp3AudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Mp3Muxing.html b/docs/classes/Mp3Muxing.html index b8720fd75..2adaa7163 100644 --- a/docs/classes/Mp3Muxing.html +++ b/docs/classes/Mp3Muxing.html @@ -1,5 +1,5 @@ Mp3Muxing | @bitmovin/api-sdk

Class Mp3Muxing

Export

Mp3Muxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -17,32 +17,32 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional filename

filename?: string

Name of the output file (required)

+

Optional filename

filename?: string

Name of the output file (required)

Memberof

Mp3Muxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.MP3

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.MP3

Discriminator property for Muxing

Memberof

Mp3Muxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Mp3MuxingInformation.html b/docs/classes/Mp3MuxingInformation.html index 297e1590d..adad678d4 100644 --- a/docs/classes/Mp3MuxingInformation.html +++ b/docs/classes/Mp3MuxingInformation.html @@ -1,5 +1,5 @@ Mp3MuxingInformation | @bitmovin/api-sdk

Class Mp3MuxingInformation

Export

Mp3MuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

ProgressiveMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

ProgressiveMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

ProgressiveMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

ProgressiveMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

ProgressiveMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

ProgressiveMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

ProgressiveMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/Mp4Muxing.html b/docs/classes/Mp4Muxing.html index d19c1e10e..82405bc46 100644 --- a/docs/classes/Mp4Muxing.html +++ b/docs/classes/Mp4Muxing.html @@ -1,5 +1,5 @@ Mp4Muxing | @bitmovin/api-sdk

Class Mp4Muxing

Export

Mp4Muxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -21,38 +21,38 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional dolbyVisionConfiguration

dolbyVisionConfiguration?: DolbyVisionMuxingConfiguration

Dolby Vision specific configuration

+

Optional dolbyVisionConfiguration

dolbyVisionConfiguration?: DolbyVisionMuxingConfiguration

Dolby Vision specific configuration

Memberof

Mp4Muxing

-

Optional filename

filename?: string

Name of the output file (either filename or name is required, prefer filename)

+

Optional filename

filename?: string

Name of the output file (either filename or name is required, prefer filename)

Memberof

Mp4Muxing

-

Optional fragmentDuration

fragmentDuration?: number

Duration of fragments in milliseconds. Required for Fragmented MP4 Muxing (for Smooth Streaming or DASH On-Demand). Not setting this will result in unfragmented mp4.

+

Optional fragmentDuration

fragmentDuration?: number

Duration of fragments in milliseconds. Required for Fragmented MP4 Muxing (for Smooth Streaming or DASH On-Demand). Not setting this will result in unfragmented mp4.

Memberof

Mp4Muxing

-

Optional fragmentedMP4MuxingManifestType

fragmentedMP4MuxingManifestType?: FragmentedMp4MuxingManifestType

Memberof

Mp4Muxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional fragmentedMP4MuxingManifestType

fragmentedMP4MuxingManifestType?: FragmentedMp4MuxingManifestType

Memberof

Mp4Muxing

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Optional timeCode

timeCode?: TimeCode

Memberof

Mp4Muxing

-

Readonly type

type: MuxingType = MuxingType.MP4

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Optional timeCode

timeCode?: TimeCode

Memberof

Mp4Muxing

+

Readonly type

type: MuxingType = MuxingType.MP4

Discriminator property for Muxing

Memberof

Mp4Muxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptiondolbyVisionConfigurationfilenamefragmentDurationfragmentedMP4MuxingManifestTypeidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreamstimeCodetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptiondolbyVisionConfigurationfilenamefragmentDurationfragmentedMP4MuxingManifestTypeidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreamstimeCodetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Mp4MuxingInformation.html b/docs/classes/Mp4MuxingInformation.html index dc6ec9318..8b3a6c8b7 100644 --- a/docs/classes/Mp4MuxingInformation.html +++ b/docs/classes/Mp4MuxingInformation.html @@ -1,5 +1,5 @@ Mp4MuxingInformation | @bitmovin/api-sdk

Class Mp4MuxingInformation

Export

Mp4MuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

ProgressiveMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

ProgressiveMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

ProgressiveMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

ProgressiveMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

ProgressiveMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

ProgressiveMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

ProgressiveMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/Muxing.html b/docs/classes/Muxing.html index 78cbad6a0..f8e052a87 100644 --- a/docs/classes/Muxing.html +++ b/docs/classes/Muxing.html @@ -1,5 +1,5 @@ Muxing | @bitmovin/api-sdk

Class Muxing

Export

Muxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -15,28 +15,28 @@ streams? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreams_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreams_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/MuxingInformationAudioTrack.html b/docs/classes/MuxingInformationAudioTrack.html index 8c8ea30f9..95364ce38 100644 --- a/docs/classes/MuxingInformationAudioTrack.html +++ b/docs/classes/MuxingInformationAudioTrack.html @@ -1,5 +1,5 @@ MuxingInformationAudioTrack | @bitmovin/api-sdk

Class MuxingInformationAudioTrack

Export

MuxingInformationAudioTrack

-

Constructors

constructor +

Constructors

constructor

Properties

bitRate? channels? codec? @@ -8,19 +8,19 @@ index? rate? sampleRate? -

Constructors

constructor

Properties

Optional bitRate

bitRate?: number

The bitrate of the audio track

+

Constructors

constructor

Properties

Optional bitRate

bitRate?: number

The bitrate of the audio track

Memberof

MuxingInformationAudioTrack

-

Optional channels

channels?: number

The number of channels in this audio stream

+

Optional channels

channels?: number

The number of channels in this audio stream

Memberof

MuxingInformationAudioTrack

-

Optional codec

codec?: string

The codec used for the track

+

Optional codec

codec?: string

The codec used for the track

Memberof

MuxingInformationAudioTrack

-

Optional codecIso

codecIso?: string

The codec string of the track

+

Optional codecIso

codecIso?: string

The codec string of the track

Memberof

MuxingInformationAudioTrack

-

Optional duration

duration?: number

The duration in seconds

+

Optional duration

duration?: number

The duration in seconds

Memberof

MuxingInformationAudioTrack

-

Optional index

index?: number

The stream index in the container

+

Optional index

index?: number

The stream index in the container

Memberof

MuxingInformationAudioTrack

-

Optional rate

rate?: number

Memberof

MuxingInformationAudioTrack

-

Optional sampleRate

sampleRate?: number

The sampling rate of the audio stream

+

Optional rate

rate?: number

Memberof

MuxingInformationAudioTrack

+

Optional sampleRate

sampleRate?: number

The sampling rate of the audio stream

Memberof

MuxingInformationAudioTrack

-

Settings

Member Visibility

Theme

On This Page

constructorbitRatechannelscodeccodecIsodurationindexratesampleRate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbitRatechannelscodeccodecIsodurationindexratesampleRate
\ No newline at end of file diff --git a/docs/classes/MuxingInformationVideoTrack.html b/docs/classes/MuxingInformationVideoTrack.html index 6ae04975c..d90ac4f8e 100644 --- a/docs/classes/MuxingInformationVideoTrack.html +++ b/docs/classes/MuxingInformationVideoTrack.html @@ -1,5 +1,5 @@ MuxingInformationVideoTrack | @bitmovin/api-sdk

Class MuxingInformationVideoTrack

Export

MuxingInformationVideoTrack

-

Constructors

constructor +

Constructors

constructor

Properties

aspectRatio? bitRate? codec? @@ -14,31 +14,31 @@ pixelFormat? rate? startTime? -

Constructors

constructor

Properties

Optional aspectRatio

aspectRatio?: string

The aspect ratio of the stream

+

Constructors

constructor

Properties

Optional aspectRatio

aspectRatio?: string

The aspect ratio of the stream

Memberof

MuxingInformationVideoTrack

-

Optional bitRate

bitRate?: number

The bitrate of the video track

+

Optional bitRate

bitRate?: number

The bitrate of the video track

Memberof

MuxingInformationVideoTrack

-

Optional codec

codec?: string

The codec used for the track

+

Optional codec

codec?: string

The codec used for the track

Memberof

MuxingInformationVideoTrack

-

Optional codecIso

codecIso?: string

The codec string of the track

+

Optional codecIso

codecIso?: string

The codec string of the track

Memberof

MuxingInformationVideoTrack

-

Optional duration

duration?: number

The duration in seconds

+

Optional duration

duration?: number

The duration in seconds

Memberof

MuxingInformationVideoTrack

-

Optional frameHeight

frameHeight?: number

The height of the frame in pixel

+

Optional frameHeight

frameHeight?: number

The height of the frame in pixel

Memberof

MuxingInformationVideoTrack

-

Optional frameMode

frameMode?: string

The frame mode (e.g. progressive)

+

Optional frameMode

frameMode?: string

The frame mode (e.g. progressive)

Memberof

MuxingInformationVideoTrack

-

Optional frameRate

frameRate?: string

The frame rate of the stream in fractional format

+

Optional frameRate

frameRate?: string

The frame rate of the stream in fractional format

Memberof

MuxingInformationVideoTrack

-

Optional frameWidth

frameWidth?: number

The width of the frame in pixel

+

Optional frameWidth

frameWidth?: number

The width of the frame in pixel

Memberof

MuxingInformationVideoTrack

-

Optional index

index?: number

The stream index in the container

+

Optional index

index?: number

The stream index in the container

Memberof

MuxingInformationVideoTrack

-

Optional numberOfFrames

numberOfFrames?: number

The number of frames of that video track

+

Optional numberOfFrames

numberOfFrames?: number

The number of frames of that video track

Memberof

MuxingInformationVideoTrack

-

Optional pixelFormat

pixelFormat?: string

The pixel format used

+

Optional pixelFormat

pixelFormat?: string

The pixel format used

Memberof

MuxingInformationVideoTrack

-

Optional rate

rate?: number

Memberof

MuxingInformationVideoTrack

-

Optional startTime

startTime?: number

The start time in seconds

+

Optional rate

rate?: number

Memberof

MuxingInformationVideoTrack

+

Optional startTime

startTime?: number

The start time in seconds

Memberof

MuxingInformationVideoTrack

-

Settings

Member Visibility

Theme

On This Page

constructoraspectRatiobitRatecodeccodecIsodurationframeHeightframeModeframeRateframeWidthindexnumberOfFramespixelFormatratestartTime
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraspectRatiobitRatecodeccodecIsodurationframeHeightframeModeframeRateframeWidthindexnumberOfFramespixelFormatratestartTime
\ No newline at end of file diff --git a/docs/classes/MuxingStream.html b/docs/classes/MuxingStream.html index c83ed8750..ac0705dcf 100644 --- a/docs/classes/MuxingStream.html +++ b/docs/classes/MuxingStream.html @@ -1,5 +1,5 @@ MuxingStream | @bitmovin/api-sdk

Class MuxingStream

Export

MuxingStream

-

Constructors

constructor +

Constructors

constructor

Properties

streamId? -

Constructors

constructor

Properties

Optional streamId

streamId?: string

Memberof

MuxingStream

-

Settings

Member Visibility

Theme

On This Page

constructorstreamId
\ No newline at end of file +

Constructors

constructor

Properties

Optional streamId

streamId?: string

Memberof

MuxingStream

+

Settings

Member Visibility

Theme

On This Page

constructorstreamId
\ No newline at end of file diff --git a/docs/classes/MuxingTypeResponse.html b/docs/classes/MuxingTypeResponse.html index 17dced138..96534bbee 100644 --- a/docs/classes/MuxingTypeResponse.html +++ b/docs/classes/MuxingTypeResponse.html @@ -1,6 +1,6 @@ MuxingTypeResponse | @bitmovin/api-sdk

Class MuxingTypeResponse

Export

MuxingTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: MuxingType

The type of the Muxing

+

Constructors

constructor

Properties

Optional type

type?: MuxingType

The type of the Muxing

Memberof

MuxingTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/MxfMuxing.html b/docs/classes/MxfMuxing.html index d60c51b9b..5e6164917 100644 --- a/docs/classes/MxfMuxing.html +++ b/docs/classes/MxfMuxing.html @@ -1,5 +1,5 @@ MxfMuxing | @bitmovin/api-sdk

Class MxfMuxing

Export

MxfMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -17,32 +17,32 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional filename

filename?: string

Name of the output file (required)

+

Optional filename

filename?: string

Name of the output file (required)

Memberof

MxfMuxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.MXF

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.MXF

Discriminator property for Muxing

Memberof

MxfMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/NexGuardFileMarker.html b/docs/classes/NexGuardFileMarker.html index b2ecebc7c..a781c1e84 100644 --- a/docs/classes/NexGuardFileMarker.html +++ b/docs/classes/NexGuardFileMarker.html @@ -1,5 +1,5 @@ NexGuardFileMarker | @bitmovin/api-sdk

Class NexGuardFileMarker

Export

NexGuardFileMarker

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -11,26 +11,26 @@ preset? strength? watermarkType? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional license

license?: string

Use the base64 license string that Nagra provides you. (required)

+

Optional license

license?: string

Use the base64 license string that Nagra provides you. (required)

Memberof

NexGuardFileMarker

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional payload

payload?: number

Specify the payload ID that you want to be associated with this output. Valid values vary depending on your Nagra NexGuard forensic watermarking workflow. For PreRelease Content (NGPR), specify an integer from 1 through 4,194,303. You must generate a unique ID for each asset you watermark, and keep a record of th ID. Neither Nagra nor Bitmovin keep track of this for you.

+

Optional payload

payload?: number

Specify the payload ID that you want to be associated with this output. Valid values vary depending on your Nagra NexGuard forensic watermarking workflow. For PreRelease Content (NGPR), specify an integer from 1 through 4,194,303. You must generate a unique ID for each asset you watermark, and keep a record of th ID. Neither Nagra nor Bitmovin keep track of this for you.

Memberof

NexGuardFileMarker

-

Optional preset

preset?: string

Enter one of the watermarking preset strings that Nagra provides you.

+

Optional preset

preset?: string

Enter one of the watermarking preset strings that Nagra provides you.

Memberof

NexGuardFileMarker

-

Optional strength

strength?: NexGuardWatermarkingStrength

Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its default value.

+

Optional strength

strength?: NexGuardWatermarkingStrength

Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its default value.

Memberof

NexGuardFileMarker

-

Optional watermarkType

watermarkType?: NexGuardWatermarkingType

The type of watermarking to be used: * OTT - A/B watermarking (for video streams only) * DUPLICATED - Stream duplication to match A/B video streams in CDN delivery (for audio streams only)

+

Optional watermarkType

watermarkType?: NexGuardWatermarkingType

The type of watermarking to be used: * OTT - A/B watermarking (for video streams only) * DUPLICATED - Stream duplication to match A/B video streams in CDN delivery (for audio streams only)

Memberof

NexGuardFileMarker

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidlicensemodifiedAtnamepayloadpresetstrengthwatermarkType
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidlicensemodifiedAtnamepayloadpresetstrengthwatermarkType
\ No newline at end of file diff --git a/docs/classes/Notification.html b/docs/classes/Notification.html index 6db52f889..b4a3698aa 100644 --- a/docs/classes/Notification.html +++ b/docs/classes/Notification.html @@ -1,5 +1,5 @@ Notification | @bitmovin/api-sdk

Class Notification

Export

Notification

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

category? customData? eventType? @@ -10,19 +10,19 @@ resourceType? triggeredAt? type? -

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

Notification

-

Optional eventType

eventType?: string

Memberof

Notification

-

Optional id

id?: string

Id of the resource (required)

+

Optional eventType

eventType?: string

Memberof

Notification

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muted

muted?: boolean

Memberof

Notification

-

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

+

Optional muted

muted?: boolean

Memberof

Notification

+

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

Memberof

Notification

-

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

+

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

Memberof

Notification

-

Optional resourceType

resourceType?: string

Memberof

Notification

-

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

+

Optional resourceType

resourceType?: string

Memberof

Notification

+

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

Memberof

Notification

-

Optional type

type?: string

Memberof

Notification

-

Settings

Member Visibility

Theme

On This Page

constructorcategorycustomDataeventTypeidmutedresolveresourceIdresourceTypetriggeredAttype
\ No newline at end of file +

Optional type

type?: string

Memberof

Notification

+

Settings

Member Visibility

Theme

On This Page

constructorcategorycustomDataeventTypeidmutedresolveresourceIdresourceTypetriggeredAttype
\ No newline at end of file diff --git a/docs/classes/NotificationStateEntry.html b/docs/classes/NotificationStateEntry.html index e094f6f7b..6b655f937 100644 --- a/docs/classes/NotificationStateEntry.html +++ b/docs/classes/NotificationStateEntry.html @@ -1,19 +1,19 @@ NotificationStateEntry | @bitmovin/api-sdk

Class NotificationStateEntry

Export

NotificationStateEntry

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? muted? notificationId? resourceId? state? triggeredAt? -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional muted

muted?: boolean

Indicate if notification was sent (required)

+

Optional muted

muted?: boolean

Indicate if notification was sent (required)

Memberof

NotificationStateEntry

-

Optional notificationId

notificationId?: string

The notification this state belongs to (required)

+

Optional notificationId

notificationId?: string

The notification this state belongs to (required)

Memberof

NotificationStateEntry

-

Optional resourceId

resourceId?: string

Indicate if triggered for specific resource (required)

+

Optional resourceId

resourceId?: string

Indicate if triggered for specific resource (required)

Memberof

NotificationStateEntry

-

Optional state

state?: NotificationStates

Memberof

NotificationStateEntry

-

Optional triggeredAt

triggeredAt?: Date

Memberof

NotificationStateEntry

-

Settings

Member Visibility

Theme

On This Page

constructoridmutednotificationIdresourceIdstatetriggeredAt
\ No newline at end of file +

Optional state

state?: NotificationStates

Memberof

NotificationStateEntry

+

Optional triggeredAt

triggeredAt?: Date

Memberof

NotificationStateEntry

+

Settings

Member Visibility

Theme

On This Page

constructoridmutednotificationIdresourceIdstatetriggeredAt
\ No newline at end of file diff --git a/docs/classes/NullLogger.html b/docs/classes/NullLogger.html index 0cc6a337f..5c6dcc3e0 100644 --- a/docs/classes/NullLogger.html +++ b/docs/classes/NullLogger.html @@ -1,4 +1,4 @@ -NullLogger | @bitmovin/api-sdk

Class NullLogger

Implements

  • Logger

Constructors

constructor +NullLogger | @bitmovin/api-sdk

Class NullLogger

Implements

  • Logger

Constructors

constructor

Methods

logRequest logResponse -

Constructors

constructor

Methods

logRequest

logResponse

Settings

Member Visibility

Theme

On This Page

constructorlogRequestlogResponse
\ No newline at end of file +

Constructors

constructor

Methods

logRequest

logResponse

Settings

Member Visibility

Theme

On This Page

constructorlogRequestlogResponse
\ No newline at end of file diff --git a/docs/classes/OpusAudioConfiguration.html b/docs/classes/OpusAudioConfiguration.html index e291582a1..195c1afc5 100644 --- a/docs/classes/OpusAudioConfiguration.html +++ b/docs/classes/OpusAudioConfiguration.html @@ -1,5 +1,5 @@ OpusAudioConfiguration | @bitmovin/api-sdk

Class OpusAudioConfiguration

Export

OpusAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: OpusChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: OpusChannelLayout

Channel layout of the audio codec configuration

Memberof

OpusAudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.OPUS

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.OPUS

Discriminator property for CodecConfiguration

Memberof

OpusAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/OrConjunction.html b/docs/classes/OrConjunction.html index 4facf156a..0f4100a60 100644 --- a/docs/classes/OrConjunction.html +++ b/docs/classes/OrConjunction.html @@ -1,11 +1,11 @@ OrConjunction | @bitmovin/api-sdk

Class OrConjunction

Export

OrConjunction

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

conditions? type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional conditions

conditions?: AbstractCondition[]

Array to perform the AND/OR evaluation on

+

Constructors

constructor

Properties

Optional conditions

conditions?: AbstractCondition[]

Array to perform the AND/OR evaluation on

Memberof

AbstractConjunction

-

Readonly type

type: ConditionType = ConditionType.OR

Discriminator property for AbstractCondition

+

Readonly type

type: ConditionType = ConditionType.OR

Discriminator property for AbstractCondition

Memberof

OrConjunction

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

  • AND: string
  • CONDITION: string
  • OR: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditionstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AND: string;
    CONDITION: string;
    OR: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorconditionstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Organization.html b/docs/classes/Organization.html index 591762f26..d78a79ebb 100644 --- a/docs/classes/Organization.html +++ b/docs/classes/Organization.html @@ -1,5 +1,5 @@ Organization | @bitmovin/api-sdk

Class Organization

Export

Organization

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,27 +12,27 @@ parentId? signupSource? type? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional labelColor

labelColor?: string

Hexadecimal color

+

Optional labelColor

labelColor?: string

Hexadecimal color

Memberof

Organization

-

Optional limitsPerResource

limitsPerResource?: ResourceLimitContainer[]

Memberof

Organization

-

Optional mfaRequired

mfaRequired?: boolean

Flag indicating if MFA is required for the organization

+

Optional limitsPerResource

limitsPerResource?: ResourceLimitContainer[]

Memberof

Organization

+

Optional mfaRequired

mfaRequired?: boolean

Flag indicating if MFA is required for the organization

Memberof

Organization

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional parentId

parentId?: string

ID of the parent organization

+

Optional parentId

parentId?: string

ID of the parent organization

Memberof

Organization

-

Optional signupSource

signupSource?: SignupSource

which platform initiated organisation creation

+

Optional signupSource

signupSource?: SignupSource

which platform initiated organisation creation

Memberof

Organization

-

Optional type

type?: OrganizationType

Specifies the type of the organization in the hierachy. Only sub-organizations can be newly created. (required)

+

Optional type

type?: OrganizationType

Specifies the type of the organization in the hierachy. Only sub-organizations can be newly created. (required)

Memberof

Organization

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidlabelColorlimitsPerResourcemfaRequiredmodifiedAtnameparentIdsignupSourcetype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidlabelColorlimitsPerResourcemfaRequiredmodifiedAtnameparentIdsignupSourcetype
\ No newline at end of file diff --git a/docs/classes/OrganizationPendingInvitation.html b/docs/classes/OrganizationPendingInvitation.html index e907d7113..0d65ac4d4 100644 --- a/docs/classes/OrganizationPendingInvitation.html +++ b/docs/classes/OrganizationPendingInvitation.html @@ -1,15 +1,15 @@ OrganizationPendingInvitation | @bitmovin/api-sdk

Class OrganizationPendingInvitation

Export

OrganizationPendingInvitation

-

Constructors

constructor +

Constructors

constructor

Properties

email? groupId? groupName? id? -

Constructors

constructor

Properties

Optional email

email?: string

Email of Tenant (required)

+

Constructors

constructor

Properties

Optional email

email?: string

Email of Tenant (required)

Memberof

OrganizationPendingInvitation

-

Optional groupId

groupId?: string

Id of group (required)

+

Optional groupId

groupId?: string

Id of group (required)

Memberof

OrganizationPendingInvitation

-

Optional groupName

groupName?: string

Name of group (required)

+

Optional groupName

groupName?: string

Name of group (required)

Memberof

OrganizationPendingInvitation

-

Optional id

id?: string

Id of Tenant (required)

+

Optional id

id?: string

Id of Tenant (required)

Memberof

OrganizationPendingInvitation

-

Settings

Member Visibility

Theme

On This Page

constructoremailgroupIdgroupNameid
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoremailgroupIdgroupNameid
\ No newline at end of file diff --git a/docs/classes/Output.html b/docs/classes/Output.html index 751fcb23d..adbac9a93 100644 --- a/docs/classes/Output.html +++ b/docs/classes/Output.html @@ -1,5 +1,5 @@ Output | @bitmovin/api-sdk

Class Output

Export

Output

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -9,18 +9,18 @@ name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/OutputTypeResponse.html b/docs/classes/OutputTypeResponse.html index a0912bd65..5ef9c248a 100644 --- a/docs/classes/OutputTypeResponse.html +++ b/docs/classes/OutputTypeResponse.html @@ -1,6 +1,6 @@ OutputTypeResponse | @bitmovin/api-sdk

Class OutputTypeResponse

Export

OutputTypeResponse

-

Constructors

constructor +

Constructors

constructor

Properties

type? -

Constructors

constructor

Properties

Optional type

type?: OutputType

The type of the output

+

Constructors

constructor

Properties

Optional type

type?: OutputType

The type of the output

Memberof

OutputTypeResponse

-

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortype
\ No newline at end of file diff --git a/docs/classes/PackedAudioMuxing.html b/docs/classes/PackedAudioMuxing.html index f82354a84..795ac7a8b 100644 --- a/docs/classes/PackedAudioMuxing.html +++ b/docs/classes/PackedAudioMuxing.html @@ -1,5 +1,5 @@ PackedAudioMuxing | @bitmovin/api-sdk

Class PackedAudioMuxing

Export

PackedAudioMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -21,40 +21,40 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Duration of a segment, given in seconds (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Duration of a segment, given in seconds (required)

Memberof

PackedAudioMuxing

-

Optional segmentNaming

segmentNaming?: string

Segment naming policy. The required filename extension depends on the codec (e.g. '.aac' for AAC). Either this or segmentNamingTemplate must be set.

+

Optional segmentNaming

segmentNaming?: string

Segment naming policy. The required filename extension depends on the codec (e.g. '.aac' for AAC). Either this or segmentNamingTemplate must be set.

Memberof

PackedAudioMuxing

-

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set. The required filename extension depends on the codec (e.g. '.aac' for AAC).

+

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set. The required filename extension depends on the codec (e.g. '.aac' for AAC).

Memberof

PackedAudioMuxing

-

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

+

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

Memberof

PackedAudioMuxing

-

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).

+

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).

Memberof

PackedAudioMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.PACKED_AUDIO

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.PACKED_AUDIO

Discriminator property for Muxing

Memberof

PackedAudioMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/PackedAudioMuxingInformation.html b/docs/classes/PackedAudioMuxingInformation.html index 6c3979be1..3f78ab5ef 100644 --- a/docs/classes/PackedAudioMuxingInformation.html +++ b/docs/classes/PackedAudioMuxingInformation.html @@ -1,5 +1,5 @@ PackedAudioMuxingInformation | @bitmovin/api-sdk

Class PackedAudioMuxingInformation

Export

PackedAudioMuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

FragmentedMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

FragmentedMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

FragmentedMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

FragmentedMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

FragmentedMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

FragmentedMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

FragmentedMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/PaddingSequence.html b/docs/classes/PaddingSequence.html index edefb2220..fe0f752ed 100644 --- a/docs/classes/PaddingSequence.html +++ b/docs/classes/PaddingSequence.html @@ -1,9 +1,9 @@ PaddingSequence | @bitmovin/api-sdk

Class PaddingSequence

Export

PaddingSequence

-

Constructors

constructor +

Constructors

constructor

Properties

duration? unit? -

Constructors

constructor

Properties

Optional duration

duration?: number

Duration of the padding sequence, given in the unit specified by the unit property. The maximum duration is 300 frames or 10 seconds. If the unit is FRAMES, this needs to be an integer value and will be interpreted based on the input frame rate of the main part of the ConcatenationInputStream that is used by your video output stream(s). FRAMES is not allowed if the encoding does not contain a video output stream. (required)

+

Constructors

constructor

Properties

Optional duration

duration?: number

Duration of the padding sequence, given in the unit specified by the unit property. The maximum duration is 300 frames or 10 seconds. If the unit is FRAMES, this needs to be an integer value and will be interpreted based on the input frame rate of the main part of the ConcatenationInputStream that is used by your video output stream(s). FRAMES is not allowed if the encoding does not contain a video output stream. (required)

Memberof

PaddingSequence

-

Optional unit

unit?: PaddingDurationUnit

The unit of the duration property

+

Optional unit

unit?: PaddingDurationUnit

The unit of the duration property

Memberof

PaddingSequence

-

Settings

Member Visibility

Theme

On This Page

constructordurationunit
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordurationunit
\ No newline at end of file diff --git a/docs/classes/PaginationResponse.html b/docs/classes/PaginationResponse.html index 4d46e7bc7..20c6e93f7 100644 --- a/docs/classes/PaginationResponse.html +++ b/docs/classes/PaginationResponse.html @@ -1,15 +1,15 @@ PaginationResponse | @bitmovin/api-sdk

Class PaginationResponse<T>

Export

PaginationResponse

-

Type Parameters

  • T

Constructors

constructor +

Type Parameters

  • T

Constructors

constructor

Properties

items? limit? next? offset? previous? totalCount? -

Constructors

constructor

Properties

Optional items

items?: T[]

Memberof

PaginationResponse

-

Optional limit

limit?: number

Memberof

PaginationResponse

-

Optional next

next?: string

Memberof

PaginationResponse

-

Optional offset

offset?: number

Memberof

PaginationResponse

-

Optional previous

previous?: string

Memberof

PaginationResponse

-

Optional totalCount

totalCount?: number

Memberof

PaginationResponse

-

Settings

Member Visibility

Theme

On This Page

constructoritemslimitnextoffsetprevioustotalCount
\ No newline at end of file +

Constructors

constructor

Properties

Optional items

items?: T[]

Memberof

PaginationResponse

+

Optional limit

limit?: number

Memberof

PaginationResponse

+

Optional next

next?: string

Memberof

PaginationResponse

+

Optional offset

offset?: number

Memberof

PaginationResponse

+

Optional previous

previous?: string

Memberof

PaginationResponse

+

Optional totalCount

totalCount?: number

Memberof

PaginationResponse

+

Settings

Member Visibility

Theme

On This Page

constructoritemslimitnextoffsetprevioustotalCount
\ No newline at end of file diff --git a/docs/classes/PassthroughAudioConfiguration.html b/docs/classes/PassthroughAudioConfiguration.html index 041ae9f75..a413e407b 100644 --- a/docs/classes/PassthroughAudioConfiguration.html +++ b/docs/classes/PassthroughAudioConfiguration.html @@ -1,5 +1,5 @@ PassthroughAudioConfiguration | @bitmovin/api-sdk

Class PassthroughAudioConfiguration

Export

PassthroughAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,18 +9,18 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: CodecConfigType = CodecConfigType.AUDIO_PASSTHROUGH

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.AUDIO_PASSTHROUGH

Discriminator property for CodecConfiguration

Memberof

PassthroughAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/PcmAudioConfiguration.html b/docs/classes/PcmAudioConfiguration.html index 70fd38809..069dc8fd6 100644 --- a/docs/classes/PcmAudioConfiguration.html +++ b/docs/classes/PcmAudioConfiguration.html @@ -1,5 +1,5 @@ PcmAudioConfiguration | @bitmovin/api-sdk

Class PcmAudioConfiguration

Export

PcmAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -14,28 +14,28 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: MONO

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: MONO

Channel layout of the audio codec configuration

Memberof

PcmAudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional presetConfiguration

presetConfiguration?: XDCAM

Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.

+

Optional presetConfiguration

presetConfiguration?: XDCAM

Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.

Memberof

PcmAudioConfiguration

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Optional sampleFormat

sampleFormat?: PcmSampleFormat

Sampling format of the audio codec configuration

+

Optional sampleFormat

sampleFormat?: PcmSampleFormat

Sampling format of the audio codec configuration

Memberof

PcmAudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.PCM

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.PCM

Discriminator property for CodecConfiguration

Memberof

PcmAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnamepresetConfigurationratesampleFormattype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnamepresetConfigurationratesampleFormattype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/PerTitle.html b/docs/classes/PerTitle.html index 42578bae4..06dabf7de 100644 --- a/docs/classes/PerTitle.html +++ b/docs/classes/PerTitle.html @@ -1,15 +1,15 @@ PerTitle | @bitmovin/api-sdk

Class PerTitle

Export

PerTitle

-

Constructors

constructor +

Constructors

constructor

Properties

av1Configuration? h264Configuration? h265Configuration? vp9Configuration? -

Constructors

constructor

Properties

Optional av1Configuration

av1Configuration?: Av1PerTitleConfiguration

Per-Title configuration for AV1

+

Constructors

constructor

Properties

Optional av1Configuration

av1Configuration?: Av1PerTitleConfiguration

Per-Title configuration for AV1

Memberof

PerTitle

-

Optional h264Configuration

h264Configuration?: H264PerTitleConfiguration

Per-Title configuration for H264

+

Optional h264Configuration

h264Configuration?: H264PerTitleConfiguration

Per-Title configuration for H264

Memberof

PerTitle

-

Optional h265Configuration

h265Configuration?: H265PerTitleConfiguration

Per-Title configuration for H265

+

Optional h265Configuration

h265Configuration?: H265PerTitleConfiguration

Per-Title configuration for H265

Memberof

PerTitle

-

Optional vp9Configuration

vp9Configuration?: Vp9PerTitleConfiguration

Per-Title configuration for VP9

+

Optional vp9Configuration

vp9Configuration?: Vp9PerTitleConfiguration

Per-Title configuration for VP9

Memberof

PerTitle

-

Settings

Member Visibility

Theme

On This Page

constructorav1Configurationh264Configurationh265Configurationvp9Configuration
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorav1Configurationh264Configurationh265Configurationvp9Configuration
\ No newline at end of file diff --git a/docs/classes/PerTitleConfiguration.html b/docs/classes/PerTitleConfiguration.html index 26ba34e41..4a7c53cfb 100644 --- a/docs/classes/PerTitleConfiguration.html +++ b/docs/classes/PerTitleConfiguration.html @@ -1,5 +1,5 @@ PerTitleConfiguration | @bitmovin/api-sdk

Class PerTitleConfiguration

Export

PerTitleConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoRepresentations? complexityFactor? fixedResolutionAndBitrateConfiguration? @@ -7,17 +7,17 @@ maxBitrateStepSize? minBitrate? minBitrateStepSize? -

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

-

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

+

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

+

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

Memberof

PerTitleConfiguration

-

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

+

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

Memberof

PerTitleConfiguration

-

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

+

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

Memberof

PerTitleConfiguration

-

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

+

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

Memberof

PerTitleConfiguration

-

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

+

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

Memberof

PerTitleConfiguration

-

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

+

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

Memberof

PerTitleConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSize
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSize
\ No newline at end of file diff --git a/docs/classes/PerTitleFixedResolutionAndBitrateConfiguration.html b/docs/classes/PerTitleFixedResolutionAndBitrateConfiguration.html index ba6635110..1634e44df 100644 --- a/docs/classes/PerTitleFixedResolutionAndBitrateConfiguration.html +++ b/docs/classes/PerTitleFixedResolutionAndBitrateConfiguration.html @@ -1,12 +1,12 @@ PerTitleFixedResolutionAndBitrateConfiguration | @bitmovin/api-sdk

Class PerTitleFixedResolutionAndBitrateConfiguration

Export

PerTitleFixedResolutionAndBitrateConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

forcedRenditionAboveHighestFixedRepresentation? forcedRenditionAboveHighestFixedRepresentationCalculationMode? forcedRenditionAboveHighestFixedRepresentationFactor? -

Constructors

constructor

Properties

Optional forcedRenditionAboveHighestFixedRepresentation

forcedRenditionAboveHighestFixedRepresentation?: number

Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.

+

Constructors

constructor

Properties

Optional forcedRenditionAboveHighestFixedRepresentation

forcedRenditionAboveHighestFixedRepresentation?: number

Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.

Memberof

PerTitleFixedResolutionAndBitrateConfiguration

-

Optional forcedRenditionAboveHighestFixedRepresentationCalculationMode

forcedRenditionAboveHighestFixedRepresentationCalculationMode?: PerTitleFixedResolutionAndBitrateConfigurationMode

Mode to calculate the bitrate of the next representation

+

Optional forcedRenditionAboveHighestFixedRepresentationCalculationMode

forcedRenditionAboveHighestFixedRepresentationCalculationMode?: PerTitleFixedResolutionAndBitrateConfigurationMode

Mode to calculate the bitrate of the next representation

Memberof

PerTitleFixedResolutionAndBitrateConfiguration

-

Optional forcedRenditionAboveHighestFixedRepresentationFactor

forcedRenditionAboveHighestFixedRepresentationFactor?: number

The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.

+

Optional forcedRenditionAboveHighestFixedRepresentationFactor

forcedRenditionAboveHighestFixedRepresentationFactor?: number

The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.

Memberof

PerTitleFixedResolutionAndBitrateConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorforcedRenditionAboveHighestFixedRepresentationforcedRenditionAboveHighestFixedRepresentationCalculationModeforcedRenditionAboveHighestFixedRepresentationFactor
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorforcedRenditionAboveHighestFixedRepresentationforcedRenditionAboveHighestFixedRepresentationCalculationModeforcedRenditionAboveHighestFixedRepresentationFactor
\ No newline at end of file diff --git a/docs/classes/Period.html b/docs/classes/Period.html index 0a9684a55..6439ba92c 100644 --- a/docs/classes/Period.html +++ b/docs/classes/Period.html @@ -1,12 +1,12 @@ Period | @bitmovin/api-sdk

Class Period

Export

Period

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

duration? id? start? -

Constructors

constructor

Properties

Optional duration

duration?: number

Duration in seconds.
Please note that the duration of a Period is usually determined by the media contained therein.
Setting the duration property to a specific value will override this default behaviour.
Warning: Use at your own risk!

+

Constructors

constructor

Properties

Optional duration

duration?: number

Duration in seconds.
Please note that the duration of a Period is usually determined by the media contained therein.
Setting the duration property to a specific value will override this default behaviour.
Warning: Use at your own risk!

Memberof

Period

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional start

start?: number

Starting time in seconds

+

Optional start

start?: number

Starting time in seconds

Memberof

Period

-

Settings

Member Visibility

Theme

On This Page

constructordurationidstart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordurationidstart
\ No newline at end of file diff --git a/docs/classes/PlaintextId3Tag.html b/docs/classes/PlaintextId3Tag.html index 296f188ad..d4856671e 100644 --- a/docs/classes/PlaintextId3Tag.html +++ b/docs/classes/PlaintextId3Tag.html @@ -1,5 +1,5 @@ PlaintextId3Tag | @bitmovin/api-sdk

Class PlaintextId3Tag

Export

PlaintextId3Tag

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -14,27 +14,27 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional frame

frame?: number

Frame number at which the Tag should be inserted

+

Optional frame

frame?: number

Frame number at which the Tag should be inserted

Memberof

Id3Tag

-

Optional frameId

frameId?: string

4 character long Frame ID (required)

+

Optional frameId

frameId?: string

4 character long Frame ID (required)

Memberof

PlaintextId3Tag

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional positionMode

positionMode?: Id3TagPositionMode

Memberof

Id3Tag

-

Optional text

text?: string

Plain Text Data (required)

+

Optional positionMode

positionMode?: Id3TagPositionMode

Memberof

Id3Tag

+

Optional text

text?: string

Plain Text Data (required)

Memberof

PlaintextId3Tag

-

Optional time

time?: number

Time in seconds where the Tag should be inserted

+

Optional time

time?: number

Time in seconds where the Tag should be inserted

Memberof

Id3Tag

-

Readonly type

type: Id3TagType = Id3TagType.PLAIN_TEXT

Discriminator property for Id3Tag

+

Readonly type

type: Id3TagType = Id3TagType.PLAIN_TEXT

Discriminator property for Id3Tag

Memberof

PlaintextId3Tag

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    FRAME_ID: string;
    PLAIN_TEXT: string;
    RAW: string;
} = ...

Type declaration

  • FRAME_ID: string
  • PLAIN_TEXT: string
  • RAW: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionframeframeIdidmodifiedAtnamepositionModetexttimetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    FRAME_ID: string;
    PLAIN_TEXT: string;
    RAW: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionframeframeIdidmodifiedAtnamepositionModetexttimetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/PlayReadyAdditionalInformation.html b/docs/classes/PlayReadyAdditionalInformation.html index aaf20fd12..74675ee5e 100644 --- a/docs/classes/PlayReadyAdditionalInformation.html +++ b/docs/classes/PlayReadyAdditionalInformation.html @@ -1,6 +1,6 @@ PlayReadyAdditionalInformation | @bitmovin/api-sdk

Class PlayReadyAdditionalInformation

Export

PlayReadyAdditionalInformation

-

Constructors

constructor +

Constructors

constructor

Properties

wrmHeaderCustomAttributes? -

Constructors

constructor

Properties

Optional wrmHeaderCustomAttributes

wrmHeaderCustomAttributes?: string

Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.

+

Constructors

constructor

Properties

Optional wrmHeaderCustomAttributes

wrmHeaderCustomAttributes?: string

Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.

Memberof

PlayReadyAdditionalInformation

-

Settings

Member Visibility

Theme

On This Page

constructorwrmHeaderCustomAttributes
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorwrmHeaderCustomAttributes
\ No newline at end of file diff --git a/docs/classes/PlayReadyDrm.html b/docs/classes/PlayReadyDrm.html index 8788af916..fbe728b4e 100644 --- a/docs/classes/PlayReadyDrm.html +++ b/docs/classes/PlayReadyDrm.html @@ -1,5 +1,5 @@ PlayReadyDrm | @bitmovin/api-sdk

Class PlayReadyDrm

Export

PlayReadyDrm

-

Hierarchy (view full)

  • Drm
    • PlayReadyDrm

Constructors

constructor +

Hierarchy (view full)

  • Drm
    • PlayReadyDrm

Constructors

constructor

Properties

additionalInformation? createdAt? customData? @@ -17,31 +17,31 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional additionalInformation

additionalInformation?: PlayReadyAdditionalInformation

Memberof

PlayReadyDrm

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional additionalInformation

additionalInformation?: PlayReadyAdditionalInformation

Memberof

PlayReadyDrm

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional key

key?: string

16 byte encryption key, 32 hexadecimal characters. Either key or keySeed is required

+

Optional key

key?: string

16 byte encryption key, 32 hexadecimal characters. Either key or keySeed is required

Memberof

PlayReadyDrm

-

Optional keySeed

keySeed?: string

Key seed to generate key. Either key or keySeed is required

+

Optional keySeed

keySeed?: string

Key seed to generate key. Either key or keySeed is required

Memberof

PlayReadyDrm

-

Optional kid

kid?: string

Key identifier

+

Optional kid

kid?: string

Key identifier

Memberof

PlayReadyDrm

-

Optional laUrl

laUrl?: string

URL of the license server

+

Optional laUrl

laUrl?: string

URL of the license server

Memberof

PlayReadyDrm

-

Optional method

method?: PlayReadyEncryptionMethod

Memberof

PlayReadyDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional method

method?: PlayReadyEncryptionMethod

Memberof

PlayReadyDrm

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Optional pssh

pssh?: string

Base64 encoded pssh payload

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Optional pssh

pssh?: string

Base64 encoded pssh payload

Memberof

PlayReadyDrm

-

Readonly type

type: DrmType = DrmType.PLAYREADY

Discriminator property for Drm

+

Readonly type

type: DrmType = DrmType.PLAYREADY

Discriminator property for Drm

Memberof

PlayReadyDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradditionalInformationcreatedAtcustomDatadescriptionidkeykeySeedkidlaUrlmethodmodifiedAtnameoutputspsshtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradditionalInformationcreatedAtcustomDatadescriptionidkeykeySeedkidlaUrlmethodmodifiedAtnameoutputspsshtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/PlayerChannel.html b/docs/classes/PlayerChannel.html index 9b5e91602..2eba020a8 100644 --- a/docs/classes/PlayerChannel.html +++ b/docs/classes/PlayerChannel.html @@ -1,9 +1,9 @@ PlayerChannel | @bitmovin/api-sdk

Class PlayerChannel

Export

PlayerChannel

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? name? -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional name

name?: string

Name of the resource (required)

+

Optional name

name?: string

Name of the resource (required)

Memberof

PlayerChannel

-

Settings

Member Visibility

Theme

On This Page

constructoridname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridname
\ No newline at end of file diff --git a/docs/classes/PlayerLicense.html b/docs/classes/PlayerLicense.html index a140ca5c8..04caf24ef 100644 --- a/docs/classes/PlayerLicense.html +++ b/docs/classes/PlayerLicense.html @@ -1,5 +1,5 @@ PlayerLicense | @bitmovin/api-sdk

Class PlayerLicense

Export

PlayerLicense

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

analyticsKey? createdAt? domains? @@ -9,22 +9,22 @@ maxImpressions? name? thirdPartyLicensingEnabled? -

Constructors

constructor

Properties

Optional analyticsKey

analyticsKey?: string

Analytics License Key

+

Constructors

constructor

Properties

Optional analyticsKey

analyticsKey?: string

Analytics License Key

Memberof

PlayerLicense

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)

Memberof

PlayerLicense

-

Optional domains

domains?: Domain[]

Whitelisted domains (required)

+

Optional domains

domains?: Domain[]

Whitelisted domains (required)

Memberof

PlayerLicense

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional impressions

impressions?: number

Number of impressions recorded (required)

+

Optional impressions

impressions?: number

Number of impressions recorded (required)

Memberof

PlayerLicense

-

Optional licenseKey

licenseKey?: string

License Key (required)

+

Optional licenseKey

licenseKey?: string

License Key (required)

Memberof

PlayerLicense

-

Optional maxImpressions

maxImpressions?: number

Maximum number of impressions (required)

+

Optional maxImpressions

maxImpressions?: number

Maximum number of impressions (required)

Memberof

PlayerLicense

-

Optional name

name?: string

Name of the resource (required)

+

Optional name

name?: string

Name of the resource (required)

Memberof

PlayerLicense

-

Optional thirdPartyLicensingEnabled

thirdPartyLicensingEnabled?: boolean

Flag if third party licensing is enabled (required)

+

Optional thirdPartyLicensingEnabled

thirdPartyLicensingEnabled?: boolean

Flag if third party licensing is enabled (required)

Memberof

PlayerLicense

-

Settings

Member Visibility

Theme

On This Page

constructoranalyticsKeycreatedAtdomainsidimpressionslicenseKeymaxImpressionsnamethirdPartyLicensingEnabled
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoranalyticsKeycreatedAtdomainsidimpressionslicenseKeymaxImpressionsnamethirdPartyLicensingEnabled
\ No newline at end of file diff --git a/docs/classes/PlayerLicenseAnalytics.html b/docs/classes/PlayerLicenseAnalytics.html index 6d6ba53d2..055751d00 100644 --- a/docs/classes/PlayerLicenseAnalytics.html +++ b/docs/classes/PlayerLicenseAnalytics.html @@ -1,6 +1,6 @@ PlayerLicenseAnalytics | @bitmovin/api-sdk

Class PlayerLicenseAnalytics

Export

PlayerLicenseAnalytics

-

Constructors

constructor +

Constructors

constructor

Properties

analyticsKey? -

Constructors

constructor

Properties

Optional analyticsKey

analyticsKey?: string

Analytics License Key (required)

+

Constructors

constructor

Properties

Optional analyticsKey

analyticsKey?: string

Analytics License Key (required)

Memberof

PlayerLicenseAnalytics

-

Settings

Member Visibility

Theme

On This Page

constructoranalyticsKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoranalyticsKey
\ No newline at end of file diff --git a/docs/classes/PlayerThirdPartyLicensing.html b/docs/classes/PlayerThirdPartyLicensing.html index 8f9462e36..1808d7a34 100644 --- a/docs/classes/PlayerThirdPartyLicensing.html +++ b/docs/classes/PlayerThirdPartyLicensing.html @@ -1,15 +1,15 @@ PlayerThirdPartyLicensing | @bitmovin/api-sdk

Class PlayerThirdPartyLicensing

Export

PlayerThirdPartyLicensing

-

Constructors

constructor +

Constructors

constructor

Properties

errorAction? licenseCheckServer? licenseCheckTimeout? timeoutAction? -

Constructors

constructor

Properties

Optional errorAction

errorAction?: PlayerThirdPartyLicensingErrorAction

Specify if the Licensing Request should fail or not on Third Party Licensing Error (required)

+

Constructors

constructor

Properties

Optional errorAction

errorAction?: PlayerThirdPartyLicensingErrorAction

Specify if the Licensing Request should fail or not on Third Party Licensing Error (required)

Memberof

PlayerThirdPartyLicensing

-

Optional licenseCheckServer

licenseCheckServer?: string

URL to your license check server (required)

+

Optional licenseCheckServer

licenseCheckServer?: string

URL to your license check server (required)

Memberof

PlayerThirdPartyLicensing

-

Optional licenseCheckTimeout

licenseCheckTimeout?: number

Timeout in ms (required)

+

Optional licenseCheckTimeout

licenseCheckTimeout?: number

Timeout in ms (required)

Memberof

PlayerThirdPartyLicensing

-

Optional timeoutAction

timeoutAction?: PlayerThirdPartyLicensingErrorAction

Specify if the Licensing Request should fail or not on Third Party Licensing timeout (required)

+

Optional timeoutAction

timeoutAction?: PlayerThirdPartyLicensingErrorAction

Specify if the Licensing Request should fail or not on Third Party Licensing timeout (required)

Memberof

PlayerThirdPartyLicensing

-

Settings

Member Visibility

Theme

On This Page

constructorerrorActionlicenseCheckServerlicenseCheckTimeouttimeoutAction
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorerrorActionlicenseCheckServerlicenseCheckTimeouttimeoutAction
\ No newline at end of file diff --git a/docs/classes/PlayerVersion.html b/docs/classes/PlayerVersion.html index acb6e5a7b..f9b015859 100644 --- a/docs/classes/PlayerVersion.html +++ b/docs/classes/PlayerVersion.html @@ -1,18 +1,18 @@ PlayerVersion | @bitmovin/api-sdk

Class PlayerVersion

Export

PlayerVersion

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cdnUrl? createdAt? downloadUrl? id? version? -

Constructors

constructor

Properties

Optional cdnUrl

cdnUrl?: string

URL of the specified player (required)

+

Constructors

constructor

Properties

Optional cdnUrl

cdnUrl?: string

URL of the specified player (required)

Memberof

PlayerVersion

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)

Memberof

PlayerVersion

-

Optional downloadUrl

downloadUrl?: string

Download URL of the specified player package (required)

+

Optional downloadUrl

downloadUrl?: string

Download URL of the specified player package (required)

Memberof

PlayerVersion

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional version

version?: string

Version of the Player (required)

+

Optional version

version?: string

Version of the Player (required)

Memberof

PlayerVersion

-

Settings

Member Visibility

Theme

On This Page

constructorcdnUrlcreatedAtdownloadUrlidversion
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcdnUrlcreatedAtdownloadUrlidversion
\ No newline at end of file diff --git a/docs/classes/PrewarmedEncoderPool.html b/docs/classes/PrewarmedEncoderPool.html index e869a42a7..15005f2c9 100644 --- a/docs/classes/PrewarmedEncoderPool.html +++ b/docs/classes/PrewarmedEncoderPool.html @@ -1,5 +1,5 @@ PrewarmedEncoderPool | @bitmovin/api-sdk

Class PrewarmedEncoderPool

Export

PrewarmedEncoderPool

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cloudRegion? createdAt? customData? @@ -14,32 +14,32 @@ name? status? targetPoolSize? -

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: CloudRegion

The cloud region in which the pool's instances will be running. Must be a specific region (e.g. not 'AUTO', 'GOOGLE' or 'EUROPE') (required)

+

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: CloudRegion

The cloud region in which the pool's instances will be running. Must be a specific region (e.g. not 'AUTO', 'GOOGLE' or 'EUROPE') (required)

Memberof

PrewarmedEncoderPool

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional diskSize

diskSize?: PrewarmedEncoderDiskSize

Disk size of the prewarmed instances in GB. Needs to be chosen depending on input file sizes and encoding features used. (required)

+

Optional diskSize

diskSize?: PrewarmedEncoderDiskSize

Disk size of the prewarmed instances in GB. Needs to be chosen depending on input file sizes and encoding features used. (required)

Memberof

PrewarmedEncoderPool

-

Optional dynamicPool

dynamicPool?: boolean

Activate dynamic pool behaviour. Pool will increase/decrease based on usage. Minimum pool size is set by targetPoolSize.

+

Optional dynamicPool

dynamicPool?: boolean

Activate dynamic pool behaviour. Pool will increase/decrease based on usage. Minimum pool size is set by targetPoolSize.

Memberof

PrewarmedEncoderPool

-

Optional encoderVersion

encoderVersion?: string

The encoder version which the pool's instances will be running (required)

+

Optional encoderVersion

encoderVersion?: string

The encoder version which the pool's instances will be running (required)

Memberof

PrewarmedEncoderPool

-

Optional gpuEnabled

gpuEnabled?: boolean

Create pool with GPU instances for hardware encoding presets (e.g., VOD_HARDWARE_SHORTFORM).

+

Optional gpuEnabled

gpuEnabled?: boolean

Create pool with GPU instances for hardware encoding presets (e.g., VOD_HARDWARE_SHORTFORM).

Memberof

PrewarmedEncoderPool

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional infrastructureId

infrastructureId?: string

Define an external infrastructure to run the pool on.

+

Optional infrastructureId

infrastructureId?: string

Define an external infrastructure to run the pool on.

Memberof

PrewarmedEncoderPool

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional status

status?: PrewarmedEncoderPoolStatus

Current status of the pool.

+

Optional status

status?: PrewarmedEncoderPoolStatus

Current status of the pool.

Memberof

PrewarmedEncoderPool

-

Optional targetPoolSize

targetPoolSize?: number

Number of instances to keep prewarmed while the pool is running (required)

+

Optional targetPoolSize

targetPoolSize?: number

Number of instances to keep prewarmed while the pool is running (required)

Memberof

PrewarmedEncoderPool

-

Settings

Member Visibility

Theme

On This Page

constructorcloudRegioncreatedAtcustomDatadescriptiondiskSizedynamicPoolencoderVersiongpuEnabledidinfrastructureIdmodifiedAtnamestatustargetPoolSize
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcloudRegioncreatedAtcustomDatadescriptiondiskSizedynamicPoolencoderVersiongpuEnabledidinfrastructureIdmodifiedAtnamestatustargetPoolSize
\ No newline at end of file diff --git a/docs/classes/PrewarmedEncoderPoolSchedule.html b/docs/classes/PrewarmedEncoderPoolSchedule.html index 9c144c9af..14efbb12a 100644 --- a/docs/classes/PrewarmedEncoderPoolSchedule.html +++ b/docs/classes/PrewarmedEncoderPoolSchedule.html @@ -1,12 +1,12 @@ PrewarmedEncoderPoolSchedule | @bitmovin/api-sdk

Class PrewarmedEncoderPoolSchedule

Export

PrewarmedEncoderPoolSchedule

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

action? id? triggerDate? -

Constructors

constructor

Properties

Optional action

action?: PrewarmedEncoderPoolAction

The action to be triggered by the schedule (start or stop) (required)

+

Constructors

constructor

Properties

Optional action

action?: PrewarmedEncoderPoolAction

The action to be triggered by the schedule (start or stop) (required)

Memberof

PrewarmedEncoderPoolSchedule

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional triggerDate

triggerDate?: Date

An instant in the future when the specified action should be triggered. Given as UTC expressed in ISO 8601 format ("YYYY-MM-DDThh:mm:ssZ"). Seconds will be ignored. (required)

+

Optional triggerDate

triggerDate?: Date

An instant in the future when the specified action should be triggered. Given as UTC expressed in ISO 8601 format ("YYYY-MM-DDThh:mm:ssZ"). Seconds will be ignored. (required)

Memberof

PrewarmedEncoderPoolSchedule

-

Settings

Member Visibility

Theme

On This Page

constructoractionidtriggerDate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoractionidtriggerDate
\ No newline at end of file diff --git a/docs/classes/PrimeTimeDrm.html b/docs/classes/PrimeTimeDrm.html index 6954223bb..78a615b56 100644 --- a/docs/classes/PrimeTimeDrm.html +++ b/docs/classes/PrimeTimeDrm.html @@ -1,5 +1,5 @@ PrimeTimeDrm | @bitmovin/api-sdk

Class PrimeTimeDrm

Export

PrimeTimeDrm

-

Hierarchy (view full)

  • Drm
    • PrimeTimeDrm

Constructors

constructor +

Hierarchy (view full)

  • Drm
    • PrimeTimeDrm

Constructors

constructor

Properties

createdAt? customData? description? @@ -13,25 +13,25 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional key

key?: string

16 byte Encryption key, 32 hexadecimal characters (required)

+

Optional key

key?: string

16 byte Encryption key, 32 hexadecimal characters (required)

Memberof

PrimeTimeDrm

-

Optional kid

kid?: string

16 byte Key id, 32 hexadecimal characters (required)

+

Optional kid

kid?: string

16 byte Key id, 32 hexadecimal characters (required)

Memberof

PrimeTimeDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Optional pssh

pssh?: string

Base 64 Encoded (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Optional pssh

pssh?: string

Base 64 Encoded (required)

Memberof

PrimeTimeDrm

-

Readonly type

type: DrmType = DrmType.PRIMETIME

Discriminator property for Drm

+

Readonly type

type: DrmType = DrmType.PRIMETIME

Discriminator property for Drm

Memberof

PrimeTimeDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidkeykidmodifiedAtnameoutputspsshtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidkeykidmodifiedAtnameoutputspsshtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ProgramDateTimeSettings.html b/docs/classes/ProgramDateTimeSettings.html index 28f766792..7bdb7ee7a 100644 --- a/docs/classes/ProgramDateTimeSettings.html +++ b/docs/classes/ProgramDateTimeSettings.html @@ -1,5 +1,5 @@ ProgramDateTimeSettings | @bitmovin/api-sdk

Class ProgramDateTimeSettings

Export

ProgramDateTimeSettings

-

Constructors

constructor +

Constructors

constructor

Properties

programDateTimeSource? -

Constructors

constructor

Properties

Optional programDateTimeSource

programDateTimeSource?: ProgramDateTimeSource

Memberof

ProgramDateTimeSettings

-

Settings

Member Visibility

Theme

On This Page

constructorprogramDateTimeSource
\ No newline at end of file +

Constructors

constructor

Properties

Optional programDateTimeSource

programDateTimeSource?: ProgramDateTimeSource

Memberof

ProgramDateTimeSettings

+

Settings

Member Visibility

Theme

On This Page

constructorprogramDateTimeSource
\ No newline at end of file diff --git a/docs/classes/ProgressiveMovMuxing.html b/docs/classes/ProgressiveMovMuxing.html index 4cbcae97f..45a0acc84 100644 --- a/docs/classes/ProgressiveMovMuxing.html +++ b/docs/classes/ProgressiveMovMuxing.html @@ -1,5 +1,5 @@ ProgressiveMovMuxing | @bitmovin/api-sdk

Class ProgressiveMovMuxing

Export

ProgressiveMovMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -17,32 +17,32 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional filename

filename?: string

Name of the output file

+

Optional filename

filename?: string

Name of the output file

Memberof

ProgressiveMovMuxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.PROGRESSIVE_MOV

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.PROGRESSIVE_MOV

Discriminator property for Muxing

Memberof

ProgressiveMovMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ProgressiveMovMuxingInformation.html b/docs/classes/ProgressiveMovMuxingInformation.html index 2998449fd..73477d972 100644 --- a/docs/classes/ProgressiveMovMuxingInformation.html +++ b/docs/classes/ProgressiveMovMuxingInformation.html @@ -1,5 +1,5 @@ ProgressiveMovMuxingInformation | @bitmovin/api-sdk

Class ProgressiveMovMuxingInformation

Export

ProgressiveMovMuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

ProgressiveMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

ProgressiveMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

ProgressiveMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

ProgressiveMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

ProgressiveMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

ProgressiveMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

ProgressiveMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/ProgressiveMuxingInformation.html b/docs/classes/ProgressiveMuxingInformation.html index a05b689fe..fd1388c40 100644 --- a/docs/classes/ProgressiveMuxingInformation.html +++ b/docs/classes/ProgressiveMuxingInformation.html @@ -1,5 +1,5 @@ ProgressiveMuxingInformation | @bitmovin/api-sdk

Class ProgressiveMuxingInformation

Export

ProgressiveMuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

ProgressiveMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

ProgressiveMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

ProgressiveMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

ProgressiveMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

ProgressiveMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

ProgressiveMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

ProgressiveMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/ProgressiveTsMuxing.html b/docs/classes/ProgressiveTsMuxing.html index e9a92f11c..45f67beb4 100644 --- a/docs/classes/ProgressiveTsMuxing.html +++ b/docs/classes/ProgressiveTsMuxing.html @@ -1,5 +1,5 @@ ProgressiveTsMuxing | @bitmovin/api-sdk

Class ProgressiveTsMuxing

Export

ProgressiveTsMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -19,36 +19,36 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional filename

filename?: string

Name of the output file

+

Optional filename

filename?: string

Name of the output file

Memberof

ProgressiveTsMuxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Length of the segments in seconds

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Length of the segments in seconds

Memberof

ProgressiveTsMuxing

-

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. e.g. first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).

+

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. e.g. first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).

Memberof

ProgressiveTsMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.PROGRESSIVE_TS

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.PROGRESSIVE_TS

Discriminator property for Muxing

Memberof

ProgressiveTsMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ProgressiveTsMuxingInformation.html b/docs/classes/ProgressiveTsMuxingInformation.html index e88824d90..6276d221e 100644 --- a/docs/classes/ProgressiveTsMuxingInformation.html +++ b/docs/classes/ProgressiveTsMuxingInformation.html @@ -1,5 +1,5 @@ ProgressiveTsMuxingInformation | @bitmovin/api-sdk

Class ProgressiveTsMuxingInformation

Export

ProgressiveTsMuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? byteRanges? containerBitrate? @@ -8,20 +8,20 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

ProgressiveMuxingInformation

-

Optional byteRanges

byteRanges?: ProgressiveTsMuxingInformationByteRanges[]

Byte ranges for the segments within the TS file

+

Optional byteRanges

byteRanges?: ProgressiveTsMuxingInformationByteRanges[]

Byte ranges for the segments within the TS file

Memberof

ProgressiveTsMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

ProgressiveMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

ProgressiveMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

ProgressiveMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

ProgressiveMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

ProgressiveMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

ProgressiveMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTracksbyteRangescontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTracksbyteRangescontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/ProgressiveTsMuxingInformationByteRanges.html b/docs/classes/ProgressiveTsMuxingInformationByteRanges.html index 457fb0e7d..f13f13f4c 100644 --- a/docs/classes/ProgressiveTsMuxingInformationByteRanges.html +++ b/docs/classes/ProgressiveTsMuxingInformationByteRanges.html @@ -1,15 +1,15 @@ ProgressiveTsMuxingInformationByteRanges | @bitmovin/api-sdk

Class ProgressiveTsMuxingInformationByteRanges

Export

ProgressiveTsMuxingInformationByteRanges

-

Constructors

constructor +

Constructors

constructor

Properties

duration? endBytes? segmentNumber? startBytes? -

Constructors

constructor

Properties

Optional duration

duration?: number

The duration of the segment in seconds

+

Constructors

constructor

Properties

Optional duration

duration?: number

The duration of the segment in seconds

Memberof

ProgressiveTsMuxingInformationByteRanges

-

Optional endBytes

endBytes?: number

The position of the last byte of the segment

+

Optional endBytes

endBytes?: number

The position of the last byte of the segment

Memberof

ProgressiveTsMuxingInformationByteRanges

-

Optional segmentNumber

segmentNumber?: number

Number of the segment (starting at 0) (required)

+

Optional segmentNumber

segmentNumber?: number

Number of the segment (starting at 0) (required)

Memberof

ProgressiveTsMuxingInformationByteRanges

-

Optional startBytes

startBytes?: number

The position of the first byte of the segment

+

Optional startBytes

startBytes?: number

The position of the first byte of the segment

Memberof

ProgressiveTsMuxingInformationByteRanges

-

Settings

Member Visibility

Theme

On This Page

constructordurationendBytessegmentNumberstartBytes
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordurationendBytessegmentNumberstartBytes
\ No newline at end of file diff --git a/docs/classes/ProgressiveWebmMuxing.html b/docs/classes/ProgressiveWebmMuxing.html index ffc725444..4565ef875 100644 --- a/docs/classes/ProgressiveWebmMuxing.html +++ b/docs/classes/ProgressiveWebmMuxing.html @@ -1,5 +1,5 @@ ProgressiveWebmMuxing | @bitmovin/api-sdk

Class ProgressiveWebmMuxing

Export

ProgressiveWebmMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -19,35 +19,35 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional filename

filename?: string

Name of the output file

+

Optional filename

filename?: string

Name of the output file

Memberof

ProgressiveWebmMuxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional manifestType

manifestType?: ProgressiveWebmMuxingManifestType

Memberof

ProgressiveWebmMuxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional manifestType

manifestType?: ProgressiveWebmMuxingManifestType

Memberof

ProgressiveWebmMuxing

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Determines the length of segments in seconds if manifestType is set to DASH_ON_DEMAND. Defaults to 4 seconds

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Determines the length of segments in seconds if manifestType is set to DASH_ON_DEMAND. Defaults to 4 seconds

Memberof

ProgressiveWebmMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.PROGRESSIVE_WEBM

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.PROGRESSIVE_WEBM

Discriminator property for Muxing

Memberof

ProgressiveWebmMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymanifestTypemaxBitrateminBitratemodifiedAtnameoutputssegmentLengthstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymanifestTypemaxBitrateminBitratemodifiedAtnameoutputssegmentLengthstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ProgressiveWebmMuxingInformation.html b/docs/classes/ProgressiveWebmMuxingInformation.html index ae48bd951..47ff4bfeb 100644 --- a/docs/classes/ProgressiveWebmMuxingInformation.html +++ b/docs/classes/ProgressiveWebmMuxingInformation.html @@ -1,5 +1,5 @@ ProgressiveWebmMuxingInformation | @bitmovin/api-sdk

Class ProgressiveWebmMuxingInformation

Export

ProgressiveWebmMuxingInformation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audioTracks? containerBitrate? containerFormat? @@ -7,18 +7,18 @@ fileSize? mimeType? videoTracks? -

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

+

Constructors

constructor

Properties

Optional audioTracks

audioTracks?: MuxingInformationAudioTrack[]

Information about the audio tracks in the container

Memberof

ProgressiveMuxingInformation

-

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

+

Optional containerBitrate

containerBitrate?: number

The bitrate of the container if available (tracks + container overhead)

Memberof

ProgressiveMuxingInformation

-

Optional containerFormat

containerFormat?: string

The container format used

+

Optional containerFormat

containerFormat?: string

The container format used

Memberof

ProgressiveMuxingInformation

-

Optional duration

duration?: number

The duration of the container in seconds

+

Optional duration

duration?: number

The duration of the container in seconds

Memberof

ProgressiveMuxingInformation

-

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

+

Optional fileSize

fileSize?: number

The file size of the muxing in bytes

Memberof

ProgressiveMuxingInformation

-

Optional mimeType

mimeType?: string

The mime type of the muxing

+

Optional mimeType

mimeType?: string

The mime type of the muxing

Memberof

ProgressiveMuxingInformation

-

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

+

Optional videoTracks

videoTracks?: MuxingInformationVideoTrack[]

Information about the video tracks in the container

Memberof

ProgressiveMuxingInformation

-

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioTrackscontainerBitratecontainerFormatdurationfileSizemimeTypevideoTracks
\ No newline at end of file diff --git a/docs/classes/PsnrQualityMetric.html b/docs/classes/PsnrQualityMetric.html index 180867cdd..80866d36d 100644 --- a/docs/classes/PsnrQualityMetric.html +++ b/docs/classes/PsnrQualityMetric.html @@ -1,8 +1,8 @@ PsnrQualityMetric | @bitmovin/api-sdk

Class PsnrQualityMetric

Export

PsnrQualityMetric

-

Constructors

constructor +

Constructors

constructor

Properties

psnr? timeSpan? -

Constructors

constructor

Properties

Optional psnr

psnr?: number

Peak signal-to-noise ratio (required)

+

Constructors

constructor

Properties

Optional psnr

psnr?: number

Peak signal-to-noise ratio (required)

Memberof

PsnrQualityMetric

-

Optional timeSpan

timeSpan?: TimeSpan

Memberof

PsnrQualityMetric

-

Settings

Member Visibility

Theme

On This Page

constructorpsnrtimeSpan
\ No newline at end of file +

Optional timeSpan

timeSpan?: TimeSpan

Memberof

PsnrQualityMetric

+

Settings

Member Visibility

Theme

On This Page

constructorpsnrtimeSpan
\ No newline at end of file diff --git a/docs/classes/RawId3Tag.html b/docs/classes/RawId3Tag.html index b246e3cf9..fd2e60a03 100644 --- a/docs/classes/RawId3Tag.html +++ b/docs/classes/RawId3Tag.html @@ -1,5 +1,5 @@ RawId3Tag | @bitmovin/api-sdk

Class RawId3Tag

Export

RawId3Tag

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bytes? createdAt? customData? @@ -13,25 +13,25 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bytes

bytes?: string

Base64 Encoded Data (required)

+

Constructors

constructor

Properties

Optional bytes

bytes?: string

Base64 Encoded Data (required)

Memberof

RawId3Tag

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional frame

frame?: number

Frame number at which the Tag should be inserted

+

Optional frame

frame?: number

Frame number at which the Tag should be inserted

Memberof

Id3Tag

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional positionMode

positionMode?: Id3TagPositionMode

Memberof

Id3Tag

-

Optional time

time?: number

Time in seconds where the Tag should be inserted

+

Optional positionMode

positionMode?: Id3TagPositionMode

Memberof

Id3Tag

+

Optional time

time?: number

Time in seconds where the Tag should be inserted

Memberof

Id3Tag

-

Readonly type

type: Id3TagType = Id3TagType.RAW

Discriminator property for Id3Tag

+

Readonly type

type: Id3TagType = Id3TagType.RAW

Discriminator property for Id3Tag

Memberof

RawId3Tag

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    FRAME_ID: string;
    PLAIN_TEXT: string;
    RAW: string;
} = ...

Type declaration

  • FRAME_ID: string
  • PLAIN_TEXT: string
  • RAW: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbytescreatedAtcustomDatadescriptionframeidmodifiedAtnamepositionModetimetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    FRAME_ID: string;
    PLAIN_TEXT: string;
    RAW: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbytescreatedAtcustomDatadescriptionframeidmodifiedAtnamepositionModetimetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/RedundantRtmpInput.html b/docs/classes/RedundantRtmpInput.html index 1a8c61bc6..946d3581f 100644 --- a/docs/classes/RedundantRtmpInput.html +++ b/docs/classes/RedundantRtmpInput.html @@ -1,5 +1,5 @@ RedundantRtmpInput | @bitmovin/api-sdk

Class RedundantRtmpInput

Export

RedundantRtmpInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? delayThreshold? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional delayThreshold

delayThreshold?: number

When there is no input signal present and this threshold in seconds is reached it will switch to another ingest point

+

Optional delayThreshold

delayThreshold?: number

When there is no input signal present and this threshold in seconds is reached it will switch to another ingest point

Memberof

RedundantRtmpInput

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ingestPoints

ingestPoints?: RtmpIngestPoint[]

Configuration for ingest points that use a dynamic IP based endpoint to stream to e.g.: rtmp://41.167.11.21/live Either ingestPoints or staticIngestPoints can be set

+

Optional ingestPoints

ingestPoints?: RtmpIngestPoint[]

Configuration for ingest points that use a dynamic IP based endpoint to stream to e.g.: rtmp://41.167.11.21/live Either ingestPoints or staticIngestPoints can be set

Memberof

RedundantRtmpInput

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional staticIngestPoints

staticIngestPoints?: StaticRtmpIngestPoint[]

Configuration for static ingest points. These ingest points use a consistent endpoint to stream to e.g.: rtmps://live-ingest.bitmovin.com/live Either ingestPoints or staticIngestPoints can be set

+

Optional staticIngestPoints

staticIngestPoints?: StaticRtmpIngestPoint[]

Configuration for static ingest points. These ingest points use a consistent endpoint to stream to e.g.: rtmps://live-ingest.bitmovin.com/live Either ingestPoints or staticIngestPoints can be set

Memberof

RedundantRtmpInput

-

Readonly type

type: InputType = InputType.REDUNDANT_RTMP

Discriminator property for Input

+

Readonly type

type: InputType = InputType.REDUNDANT_RTMP

Discriminator property for Input

Memberof

RedundantRtmpInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadelayThresholddescriptionidingestPointsmodifiedAtnamestaticIngestPointstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadelayThresholddescriptionidingestPointsmodifiedAtnamestaticIngestPointstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ReprioritizeEncodingRequest.html b/docs/classes/ReprioritizeEncodingRequest.html index 59df0e3b3..3d6574d6f 100644 --- a/docs/classes/ReprioritizeEncodingRequest.html +++ b/docs/classes/ReprioritizeEncodingRequest.html @@ -1,6 +1,6 @@ ReprioritizeEncodingRequest | @bitmovin/api-sdk

Class ReprioritizeEncodingRequest

Export

ReprioritizeEncodingRequest

-

Constructors

constructor +

Constructors

constructor

Properties

priority? -

Constructors

constructor

Properties

Optional priority

priority?: number

Priority of the Encoding (required)

+

Constructors

constructor

Properties

Optional priority

priority?: number

Priority of the Encoding (required)

Memberof

ReprioritizeEncodingRequest

-

Settings

Member Visibility

Theme

On This Page

constructorpriority
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpriority
\ No newline at end of file diff --git a/docs/classes/RescheduleEncodingRequest.html b/docs/classes/RescheduleEncodingRequest.html index 9cea6c7dc..f060c9649 100644 --- a/docs/classes/RescheduleEncodingRequest.html +++ b/docs/classes/RescheduleEncodingRequest.html @@ -1,6 +1,6 @@ RescheduleEncodingRequest | @bitmovin/api-sdk

Class RescheduleEncodingRequest

Export

RescheduleEncodingRequest

-

Constructors

constructor +

Constructors

constructor

Properties

infrastructureId? -

Constructors

constructor

Properties

Optional infrastructureId

infrastructureId?: string

Id of a custom infrastructure, e.g., AWS Cloud Connect

+

Constructors

constructor

Properties

Optional infrastructureId

infrastructureId?: string

Id of a custom infrastructure, e.g., AWS Cloud Connect

Memberof

RescheduleEncodingRequest

-

Settings

Member Visibility

Theme

On This Page

constructorinfrastructureId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorinfrastructureId
\ No newline at end of file diff --git a/docs/classes/ResetLiveManifestTimeShift.html b/docs/classes/ResetLiveManifestTimeShift.html index 8c37263af..a01795c73 100644 --- a/docs/classes/ResetLiveManifestTimeShift.html +++ b/docs/classes/ResetLiveManifestTimeShift.html @@ -1,12 +1,12 @@ ResetLiveManifestTimeShift | @bitmovin/api-sdk

Class ResetLiveManifestTimeShift

Export

ResetLiveManifestTimeShift

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? manifestIds? residualPeriodInSeconds? -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional manifestIds

manifestIds?: string[]

The ids of the manifests to update. If this property is not set, all manifests tied to the encoding are updated.

+

Optional manifestIds

manifestIds?: string[]

The ids of the manifests to update. If this property is not set, all manifests tied to the encoding are updated.

Memberof

ResetLiveManifestTimeShift

-

Optional residualPeriodInSeconds

residualPeriodInSeconds?: number

Determines how many seconds will be left in the manifest after segments are removed. If this is not set, all but one segment will be removed.

+

Optional residualPeriodInSeconds

residualPeriodInSeconds?: number

Determines how many seconds will be left in the manifest after segments are removed. If this is not set, all but one segment will be removed.

Memberof

ResetLiveManifestTimeShift

-

Settings

Member Visibility

Theme

On This Page

constructoridmanifestIdsresidualPeriodInSeconds
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridmanifestIdsresidualPeriodInSeconds
\ No newline at end of file diff --git a/docs/classes/ResourceLimit.html b/docs/classes/ResourceLimit.html index e24645d4d..a6b77ab16 100644 --- a/docs/classes/ResourceLimit.html +++ b/docs/classes/ResourceLimit.html @@ -1,10 +1,10 @@ ResourceLimit | @bitmovin/api-sdk

Class ResourceLimit

Export

ResourceLimit

-

Constructors

constructor +

Constructors

constructor

Properties

effectiveValue? name? value? -

Constructors

constructor

Properties

Optional effectiveValue

effectiveValue?: string

Specifies the remaining limit value for limits divided to sub-organizations. This property is returned only for parent organizations and only for mentioned limits.

+

Constructors

constructor

Properties

Optional effectiveValue

effectiveValue?: string

Specifies the remaining limit value for limits divided to sub-organizations. This property is returned only for parent organizations and only for mentioned limits.

Memberof

ResourceLimit

-

Optional name

name?: string

Memberof

ResourceLimit

-

Optional value

value?: string

Memberof

ResourceLimit

-

Settings

Member Visibility

Theme

On This Page

constructoreffectiveValuenamevalue
\ No newline at end of file +

Optional name

name?: string

Memberof

ResourceLimit

+

Optional value

value?: string

Memberof

ResourceLimit

+

Settings

Member Visibility

Theme

On This Page

constructoreffectiveValuenamevalue
\ No newline at end of file diff --git a/docs/classes/ResourceLimitContainer.html b/docs/classes/ResourceLimitContainer.html index fadeb888e..c42711b65 100644 --- a/docs/classes/ResourceLimitContainer.html +++ b/docs/classes/ResourceLimitContainer.html @@ -1,7 +1,7 @@ ResourceLimitContainer | @bitmovin/api-sdk

Class ResourceLimitContainer

Export

ResourceLimitContainer

-

Constructors

constructor +

Constructors

constructor

Properties

limits? resource? -

Constructors

constructor

Properties

Optional limits

limits?: ResourceLimit[]

Memberof

ResourceLimitContainer

-

Optional resource

resource?: ResourceType

Memberof

ResourceLimitContainer

-

Settings

Member Visibility

Theme

On This Page

constructorlimitsresource
\ No newline at end of file +

Constructors

constructor

Properties

Optional limits

limits?: ResourceLimit[]

Memberof

ResourceLimitContainer

+

Optional resource

resource?: ResourceType

Memberof

ResourceLimitContainer

+

Settings

Member Visibility

Theme

On This Page

constructorlimitsresource
\ No newline at end of file diff --git a/docs/classes/ResponseErrorData.html b/docs/classes/ResponseErrorData.html index 95dc39fad..8a781c215 100644 --- a/docs/classes/ResponseErrorData.html +++ b/docs/classes/ResponseErrorData.html @@ -1,18 +1,18 @@ ResponseErrorData | @bitmovin/api-sdk

Class ResponseErrorData

Export

ResponseErrorData

-

Constructors

constructor +

Constructors

constructor

Properties

code? details? developerMessage? links? message? -

Constructors

constructor

Properties

Optional code

code?: number

Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes (required)

+

Constructors

constructor

Properties

Optional code

code?: number

Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes (required)

Memberof

ResponseErrorData

-

Optional details

details?: Message[]

collection of messages containing more detailed information on the cause of the error

+

Optional details

details?: Message[]

collection of messages containing more detailed information on the cause of the error

Memberof

ResponseErrorData

-

Optional developerMessage

developerMessage?: string

More detailed message meant for developers (required)

+

Optional developerMessage

developerMessage?: string

More detailed message meant for developers (required)

Memberof

ResponseErrorData

-

Optional links

links?: Link[]

collection of links to webpages containing further information on the topic

+

Optional links

links?: Link[]

collection of links to webpages containing further information on the topic

Memberof

ResponseErrorData

-

Optional message

message?: string

General error message (required)

+

Optional message

message?: string

General error message (required)

Memberof

ResponseErrorData

-

Settings

Member Visibility

Theme

On This Page

constructorcodedetailsdeveloperMessagelinksmessage
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcodedetailsdeveloperMessagelinksmessage
\ No newline at end of file diff --git a/docs/classes/ReuploadSettings.html b/docs/classes/ReuploadSettings.html index 0347aaad2..a373c9047 100644 --- a/docs/classes/ReuploadSettings.html +++ b/docs/classes/ReuploadSettings.html @@ -1,12 +1,12 @@ ReuploadSettings | @bitmovin/api-sdk

Class ReuploadSettings

Export

ReuploadSettings

-

Constructors

constructor +

Constructors

constructor

Properties

dashManifestInterval? hlsManifestInterval? muxingInitFileInterval? -

Constructors

constructor

Properties

Optional dashManifestInterval

dashManifestInterval?: number

Interval in seconds to reupload the DASH manifest. Valid values are either null to never reupload the dash manifest or at least 30.

+

Constructors

constructor

Properties

Optional dashManifestInterval

dashManifestInterval?: number

Interval in seconds to reupload the DASH manifest. Valid values are either null to never reupload the dash manifest or at least 30.

Memberof

ReuploadSettings

-

Optional hlsManifestInterval

hlsManifestInterval?: number

Interval in seconds to reupload the HLS master file. Valid values are either 0 to never reupload the hls manifest or at least 30. This is currently not used, as the master file will always be uploaded when one of the playlist files has changed.

+

Optional hlsManifestInterval

hlsManifestInterval?: number

Interval in seconds to reupload the HLS master file. Valid values are either 0 to never reupload the hls manifest or at least 30. This is currently not used, as the master file will always be uploaded when one of the playlist files has changed.

Memberof

ReuploadSettings

-

Optional muxingInitFileInterval

muxingInitFileInterval?: number

The interval in seconds to reupload the init file for segmented muxings, e.g. fMP4, WebM. Valid values are either null to never reupload the init file for segmented muxings or at least 30.

+

Optional muxingInitFileInterval

muxingInitFileInterval?: number

The interval in seconds to reupload the init file for segmented muxings, e.g. fMP4, WebM. Valid values are either null to never reupload the init file for segmented muxings or at least 30.

Memberof

ReuploadSettings

-

Settings

Member Visibility

Theme

On This Page

constructordashManifestIntervalhlsManifestIntervalmuxingInitFileInterval
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordashManifestIntervalhlsManifestIntervalmuxingInitFileInterval
\ No newline at end of file diff --git a/docs/classes/RotateFilter.html b/docs/classes/RotateFilter.html index 994b52181..3cd446064 100644 --- a/docs/classes/RotateFilter.html +++ b/docs/classes/RotateFilter.html @@ -1,5 +1,5 @@ RotateFilter | @bitmovin/api-sdk

Class RotateFilter

Export

RotateFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -10,20 +10,20 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rotation

rotation?: number

Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise. (required)

+

Optional rotation

rotation?: number

Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise. (required)

Memberof

RotateFilter

-

Readonly type

type: FilterType = FilterType.ROTATE

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.ROTATE

Discriminator property for Filter

Memberof

RotateFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamerotationtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnamerotationtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/RtmpIngestPoint.html b/docs/classes/RtmpIngestPoint.html index 9df2e46e2..2687ab117 100644 --- a/docs/classes/RtmpIngestPoint.html +++ b/docs/classes/RtmpIngestPoint.html @@ -1,9 +1,9 @@ RtmpIngestPoint | @bitmovin/api-sdk

Class RtmpIngestPoint

Export

RtmpIngestPoint

-

Constructors

constructor +

Constructors

constructor

Properties

applicationName? streamKey? -

Constructors

constructor

Properties

Optional applicationName

applicationName?: string

The name of the application where the ingest is streamed to. This has to be unique for each ingest point (required)

+

Constructors

constructor

Properties

Optional applicationName

applicationName?: string

The name of the application where the ingest is streamed to. This has to be unique for each ingest point (required)

Memberof

RtmpIngestPoint

-

Optional streamKey

streamKey?: string

The stream key for the backup input (required)

+

Optional streamKey

streamKey?: string

The stream key for the backup input (required)

Memberof

RtmpIngestPoint

-

Settings

Member Visibility

Theme

On This Page

constructorapplicationNamestreamKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapplicationNamestreamKey
\ No newline at end of file diff --git a/docs/classes/RtmpInput.html b/docs/classes/RtmpInput.html index e16f375a8..fdeac22f2 100644 --- a/docs/classes/RtmpInput.html +++ b/docs/classes/RtmpInput.html @@ -1,5 +1,5 @@ RtmpInput | @bitmovin/api-sdk

Class RtmpInput

Export

RtmpInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,18 +9,18 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: InputType = InputType.RTMP

Discriminator property for Input

+

Readonly type

type: InputType = InputType.RTMP

Discriminator property for Input

Memberof

RtmpInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/S3Input.html b/docs/classes/S3Input.html index 92b8b11e0..8788bcd12 100644 --- a/docs/classes/S3Input.html +++ b/docs/classes/S3Input.html @@ -1,5 +1,5 @@ S3Input | @bitmovin/api-sdk

Class S3Input

Export

S3Input

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? bucketName? cloudRegion? @@ -13,26 +13,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Amazon access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Amazon access key (required)

Memberof

S3Input

-

Optional bucketName

bucketName?: string

Name of the bucket (required)

+

Optional bucketName

bucketName?: string

Name of the bucket (required)

Memberof

S3Input

-

Optional cloudRegion

cloudRegion?: AwsCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

+

Optional cloudRegion

cloudRegion?: AwsCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

Memberof

S3Input

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional secretKey

secretKey?: string

Amazon secret key (required)

+

Optional secretKey

secretKey?: string

Amazon secret key (required)

Memberof

S3Input

-

Readonly type

type: InputType = InputType.S3

Discriminator property for Input

+

Readonly type

type: InputType = InputType.S3

Discriminator property for Input

Memberof

S3Input

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeybucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnamesecretKeytype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeybucketNamecloudRegioncreatedAtcustomDatadescriptionidmodifiedAtnamesecretKeytype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/S3Output.html b/docs/classes/S3Output.html index d6bc3c5a7..1a7416fcd 100644 --- a/docs/classes/S3Output.html +++ b/docs/classes/S3Output.html @@ -1,5 +1,5 @@ S3Output | @bitmovin/api-sdk

Class S3Output

Export

S3Output

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? acl? bucketName? @@ -16,32 +16,32 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Amazon S3 access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

Amazon S3 access key (required)

Memberof

S3Output

-

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional bucketName

bucketName?: string

Amazon S3 bucket name (required)

+

Optional bucketName

bucketName?: string

Amazon S3 bucket name (required)

Memberof

S3Output

-

Optional cloudRegion

cloudRegion?: AwsCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

+

Optional cloudRegion

cloudRegion?: AwsCloudRegion

The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.

Memberof

S3Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional md5MetaTag

md5MetaTag?: string

If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.

+

Optional md5MetaTag

md5MetaTag?: string

If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.

Memberof

S3Output

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional secretKey

secretKey?: string

Amazon S3 secret key (required)

+

Optional secretKey

secretKey?: string

Amazon S3 secret key (required)

Memberof

S3Output

-

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication. Must be set to S3_V2 if the region supports both V2 and V4, but the bucket allows V2 only (see https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)

+

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication. Must be set to S3_V2 if the region supports both V2 and V4, but the bucket allows V2 only (see https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)

Memberof

S3Output

-

Readonly type

type: OutputType = OutputType.S3

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.S3

Discriminator property for Output

Memberof

S3Output

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaclbucketNamecloudRegioncreatedAtcustomDatadescriptionidmd5MetaTagmodifiedAtnamesecretKeysignatureVersiontype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessKeyaclbucketNamecloudRegioncreatedAtcustomDatadescriptionidmd5MetaTagmodifiedAtnamesecretKeysignatureVersiontype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/S3RoleBasedInput.html b/docs/classes/S3RoleBasedInput.html index ae88b7c71..cb54e2426 100644 --- a/docs/classes/S3RoleBasedInput.html +++ b/docs/classes/S3RoleBasedInput.html @@ -1,5 +1,5 @@ S3RoleBasedInput | @bitmovin/api-sdk

Class S3RoleBasedInput

Export

S3RoleBasedInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bucketName? cloudRegion? createdAt? @@ -14,26 +14,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bucketName

bucketName?: string

Amazon S3 bucket name (required)

+

Constructors

constructor

Properties

Optional bucketName

bucketName?: string

Amazon S3 bucket name (required)

Memberof

S3RoleBasedInput

-

Optional cloudRegion

cloudRegion?: AwsCloudRegion

Memberof

S3RoleBasedInput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional cloudRegion

cloudRegion?: AwsCloudRegion

Memberof

S3RoleBasedInput

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional externalId

externalId?: string

External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won't be able to read from the S3 bucket. An appropriate trust policy would look like this: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "{{externalId}}" is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the input configuration Bitmovin won't be able to read from the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new input, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

+

Optional externalId

externalId?: string

External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won't be able to read from the S3 bucket. An appropriate trust policy would look like this: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "{{externalId}}" is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the input configuration Bitmovin won't be able to read from the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new input, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

Memberof

S3RoleBasedInput

-

Optional externalIdMode

externalIdMode?: ExternalIdMode

Memberof

S3RoleBasedInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional externalIdMode

externalIdMode?: ExternalIdMode

Memberof

S3RoleBasedInput

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to read data from your S3 bucket. Please note that the IAM role has to have read access on S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)

+

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to read data from your S3 bucket. Please note that the IAM role has to have read access on S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)

Memberof

S3RoleBasedInput

-

Readonly type

type: InputType = InputType.S3_ROLE_BASED

Discriminator property for Input

+

Readonly type

type: InputType = InputType.S3_ROLE_BASED

Discriminator property for Input

Memberof

S3RoleBasedInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbucketNamecloudRegioncreatedAtcustomDatadescriptionexternalIdexternalIdModeidmodifiedAtnameroleArntype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbucketNamecloudRegioncreatedAtcustomDatadescriptionexternalIdexternalIdModeidmodifiedAtnameroleArntype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/S3RoleBasedOutput.html b/docs/classes/S3RoleBasedOutput.html index f89418e71..705a85711 100644 --- a/docs/classes/S3RoleBasedOutput.html +++ b/docs/classes/S3RoleBasedOutput.html @@ -1,5 +1,5 @@ S3RoleBasedOutput | @bitmovin/api-sdk

Class S3RoleBasedOutput

Export

S3RoleBasedOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? bucketName? cloudRegion? @@ -17,32 +17,32 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional bucketName

bucketName?: string

Amazon S3 bucket name (required)

+

Optional bucketName

bucketName?: string

Amazon S3 bucket name (required)

Memberof

S3RoleBasedOutput

-

Optional cloudRegion

cloudRegion?: AwsCloudRegion

Memberof

S3RoleBasedOutput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional cloudRegion

cloudRegion?: AwsCloudRegion

Memberof

S3RoleBasedOutput

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional externalId

externalId?: string

External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won't be able to write to the S3 bucket. An appropriate trust policy would look like this: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "{{externalId}}" is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the output configuration Bitmovin won't be able to write to the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new output, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

+

Optional externalId

externalId?: string

External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won't be able to write to the S3 bucket. An appropriate trust policy would look like this: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "{{externalId}}" is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the output configuration Bitmovin won't be able to write to the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new output, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

Memberof

S3RoleBasedOutput

-

Optional externalIdMode

externalIdMode?: ExternalIdMode

Memberof

S3RoleBasedOutput

-

Optional id

id?: string

Id of the resource (required)

+

Optional externalIdMode

externalIdMode?: ExternalIdMode

Memberof

S3RoleBasedOutput

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional md5MetaTag

md5MetaTag?: string

If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.

+

Optional md5MetaTag

md5MetaTag?: string

If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.

Memberof

S3RoleBasedOutput

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to write data to your S3 bucket. Please note that the IAM role has to have write access to S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)

+

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to write data to your S3 bucket. Please note that the IAM role has to have write access to S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)

Memberof

S3RoleBasedOutput

-

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication

+

Optional signatureVersion

signatureVersion?: S3SignatureVersion

Specifies the method used for authentication

Memberof

S3RoleBasedOutput

-

Readonly type

type: OutputType = OutputType.S3_ROLE_BASED

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.S3_ROLE_BASED

Discriminator property for Output

Memberof

S3RoleBasedOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclbucketNamecloudRegioncreatedAtcustomDatadescriptionexternalIdexternalIdModeidmd5MetaTagmodifiedAtnameroleArnsignatureVersiontype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclbucketNamecloudRegioncreatedAtcustomDatadescriptionexternalIdexternalIdModeidmd5MetaTagmodifiedAtnameroleArnsignatureVersiontype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/ScaleFilter.html b/docs/classes/ScaleFilter.html index cf24b0e59..63b03c23a 100644 --- a/docs/classes/ScaleFilter.html +++ b/docs/classes/ScaleFilter.html @@ -1,5 +1,5 @@ ScaleFilter | @bitmovin/api-sdk

Class ScaleFilter

Export

ScaleFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -14,27 +14,27 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional height

height?: number

The height of the output frame in pixels. If not set it will be based on the configured width by maintaining the original aspect ratio. If width is also not set, the original source dimensions will be applied.

+

Optional height

height?: number

The height of the output frame in pixels. If not set it will be based on the configured width by maintaining the original aspect ratio. If width is also not set, the original source dimensions will be applied.

Memberof

ScaleFilter

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set.

+

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set.

Memberof

ScaleFilter

-

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set.

+

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set.

Memberof

ScaleFilter

-

Optional scalingAlgorithm

scalingAlgorithm?: ScalingAlgorithm

Memberof

ScaleFilter

-

Readonly type

type: FilterType = FilterType.SCALE

Discriminator property for Filter

+

Optional scalingAlgorithm

scalingAlgorithm?: ScalingAlgorithm

Memberof

ScaleFilter

+

Readonly type

type: FilterType = FilterType.SCALE

Discriminator property for Filter

Memberof

ScaleFilter

-

Optional width

width?: number

The width of the output frame in pixels. If not set it will be based on the configured height by maintaining the original aspect ratio. If height is also not set, the original source dimensions will be applied.

+

Optional width

width?: number

The width of the output frame in pixels. If not set it will be based on the configured height by maintaining the original aspect ratio. If height is also not set, the original source dimensions will be applied.

Memberof

ScaleFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionheightidmodifiedAtnamesampleAspectRatioDenominatorsampleAspectRatioNumeratorscalingAlgorithmtypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionheightidmodifiedAtnamesampleAspectRatioDenominatorsampleAspectRatioNumeratorscalingAlgorithmtypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SccCaption.html b/docs/classes/SccCaption.html index 1a3987b5a..07114b52d 100644 --- a/docs/classes/SccCaption.html +++ b/docs/classes/SccCaption.html @@ -1,5 +1,5 @@ SccCaption | @bitmovin/api-sdk

Class SccCaption

Export

SccCaption

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,20 +8,20 @@ modifiedAt? name? smpteTimecodeFlavor? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional input

input?: InputPath

Input location of the SCC file (required)

+

Optional input

input?: InputPath

Input location of the SCC file (required)

Memberof

SccCaption

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional smpteTimecodeFlavor

smpteTimecodeFlavor?: SmpteTimecodeFlavor

Flavor of SMPTE timecodes in the SCC file (drop-frame or non-drop)

+

Optional smpteTimecodeFlavor

smpteTimecodeFlavor?: SmpteTimecodeFlavor

Flavor of SMPTE timecodes in the SCC file (drop-frame or non-drop)

Memberof

SccCaption

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputmodifiedAtnamesmpteTimecodeFlavor
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputmodifiedAtnamesmpteTimecodeFlavor
\ No newline at end of file diff --git a/docs/classes/ScheduledInsertableContent.html b/docs/classes/ScheduledInsertableContent.html index 06ebb3f43..741a608e5 100644 --- a/docs/classes/ScheduledInsertableContent.html +++ b/docs/classes/ScheduledInsertableContent.html @@ -1,5 +1,5 @@ ScheduledInsertableContent | @bitmovin/api-sdk

Class ScheduledInsertableContent

Export

ScheduledInsertableContent

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

contentId? createdAt? customData? @@ -10,24 +10,24 @@ name? runAt? status? -

Constructors

constructor

Properties

Optional contentId

contentId?: string

Id of the insertable content to play instead of the live stream

+

Constructors

constructor

Properties

Optional contentId

contentId?: string

Id of the insertable content to play instead of the live stream

Memberof

ScheduledInsertableContent

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional durationInSeconds

durationInSeconds?: number

Duration for how long to play the content. Cut off if shorter, loop if longer than actual duration. This property is required if the insertable content is an image.

+

Optional durationInSeconds

durationInSeconds?: number

Duration for how long to play the content. Cut off if shorter, loop if longer than actual duration. This property is required if the insertable content is an image.

Memberof

ScheduledInsertableContent

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional runAt

runAt?: Date

Time to play the content in UTC: YYYY-MM-DDThh:mm:ssZ, if this property is not set the content will be played as soon as possible.

+

Optional runAt

runAt?: Date

Time to play the content in UTC: YYYY-MM-DDThh:mm:ssZ, if this property is not set the content will be played as soon as possible.

Memberof

ScheduledInsertableContent

-

Optional status

status?: ScheduledInsertableContentStatus

Status of the scheduled insertable content.

+

Optional status

status?: ScheduledInsertableContentStatus

Status of the scheduled insertable content.

Memberof

ScheduledInsertableContent

-

Settings

Member Visibility

Theme

On This Page

constructorcontentIdcreatedAtcustomDatadescriptiondurationInSecondsidmodifiedAtnamerunAtstatus
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcontentIdcreatedAtcustomDatadescriptiondurationInSecondsidmodifiedAtnamerunAtstatus
\ No newline at end of file diff --git a/docs/classes/Scheduling.html b/docs/classes/Scheduling.html index c25099496..f585fb4fd 100644 --- a/docs/classes/Scheduling.html +++ b/docs/classes/Scheduling.html @@ -1,9 +1,9 @@ Scheduling | @bitmovin/api-sdk

Class Scheduling

Export

Scheduling

-

Constructors

constructor +

Constructors

constructor

Properties

prewarmedEncoderPoolIds? priority? -

Constructors

constructor

Properties

Optional prewarmedEncoderPoolIds

prewarmedEncoderPoolIds?: string[]

List of prewarmed encoder pools. If set, prewarmed encoders from pools with these IDs will be used for the encoding if available. The pool IDs will be tried in the order in which they are passed.

+

Constructors

constructor

Properties

Optional prewarmedEncoderPoolIds

prewarmedEncoderPoolIds?: string[]

List of prewarmed encoder pools. If set, prewarmed encoders from pools with these IDs will be used for the encoding if available. The pool IDs will be tried in the order in which they are passed.

Memberof

Scheduling

-

Optional priority

priority?: number

Specifies the priority of this encoding (0 - 100). Higher numbers mean higher priority. Default is 50.

+

Optional priority

priority?: number

Specifies the priority of this encoding (0 - 100). Higher numbers mean higher priority. Default is 50.

Memberof

Scheduling

-

Settings

Member Visibility

Theme

On This Page

constructorprewarmedEncoderPoolIdspriority
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorprewarmedEncoderPoolIdspriority
\ No newline at end of file diff --git a/docs/classes/Scte35Cue.html b/docs/classes/Scte35Cue.html index 6735843dd..3a44df3df 100644 --- a/docs/classes/Scte35Cue.html +++ b/docs/classes/Scte35Cue.html @@ -1,12 +1,12 @@ Scte35Cue | @bitmovin/api-sdk

Class Scte35Cue

Export

Scte35Cue

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cueDuration? id? manifestIds? -

Constructors

constructor

Properties

Optional cueDuration

cueDuration?: number

Cue out duration in seconds. (required)

+

Constructors

constructor

Properties

Optional cueDuration

cueDuration?: number

Cue out duration in seconds. (required)

Memberof

Scte35Cue

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional manifestIds

manifestIds?: string[]

The ids of the manifests to update. If this property is not set, all the manifests tied to the encoding are updated.

+

Optional manifestIds

manifestIds?: string[]

The ids of the manifests to update. If this property is not set, all the manifests tied to the encoding are updated.

Memberof

Scte35Cue

-

Settings

Member Visibility

Theme

On This Page

constructorcueDurationidmanifestIds
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcueDurationidmanifestIds
\ No newline at end of file diff --git a/docs/classes/SegmentedRawMuxing.html b/docs/classes/SegmentedRawMuxing.html index 878201bbc..207eba9e4 100644 --- a/docs/classes/SegmentedRawMuxing.html +++ b/docs/classes/SegmentedRawMuxing.html @@ -1,5 +1,5 @@ SegmentedRawMuxing | @bitmovin/api-sdk

Class SegmentedRawMuxing

Export

SegmentedRawMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -19,36 +19,36 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds (required)

Memberof

SegmentedRawMuxing

-

Optional segmentNaming

segmentNaming?: string

Segment naming policy (required)

+

Optional segmentNaming

segmentNaming?: string

Segment naming policy (required)

Memberof

SegmentedRawMuxing

-

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

+

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

Memberof

SegmentedRawMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.SEGMENTED_RAW

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.SEGMENTED_RAW

Discriminator property for Muxing

Memberof

SegmentedRawMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentsMuxedstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentsMuxedstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SegmentsMediaInfo.html b/docs/classes/SegmentsMediaInfo.html index 154ef44f0..0a5fbbfcb 100644 --- a/docs/classes/SegmentsMediaInfo.html +++ b/docs/classes/SegmentsMediaInfo.html @@ -1,5 +1,5 @@ SegmentsMediaInfo | @bitmovin/api-sdk

Class SegmentsMediaInfo

Export

SegmentsMediaInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assocLanguage? autoselect? characteristics? @@ -15,34 +15,34 @@ segmentPath? startSegmentNumber? streamId? -

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

+

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

Memberof

BasicMediaInfo

-

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

+

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

Memberof

BasicMediaInfo

-

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

+

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

Memberof

BasicMediaInfo

-

Optional drmId

drmId?: string

Id of the DRM.

+

Optional drmId

drmId?: string

Id of the DRM.

Memberof

SegmentsMediaInfo

-

Optional encodingId

encodingId?: string

Id of the encoding. (required)

+

Optional encodingId

encodingId?: string

Id of the encoding. (required)

Memberof

SegmentsMediaInfo

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

Memberof

SegmentsMediaInfo

-

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

+

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

Memberof

BasicMediaInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

+

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

Memberof

BasicMediaInfo

-

Optional language

language?: string

Primary language in the rendition.

+

Optional language

language?: string

Primary language in the rendition.

Memberof

BasicMediaInfo

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

SegmentsMediaInfo

-

Optional name

name?: string

Human readable description of the rendition. (required)

+

Optional name

name?: string

Human readable description of the rendition. (required)

Memberof

BasicMediaInfo

-

Optional segmentPath

segmentPath?: string

Path to segments. (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. (required)

Memberof

SegmentsMediaInfo

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

Memberof

SegmentsMediaInfo

-

Optional streamId

streamId?: string

Id of the stream. (required)

+

Optional streamId

streamId?: string

Id of the stream. (required)

Memberof

SegmentsMediaInfo

-

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumbergroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumbergroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamId
\ No newline at end of file diff --git a/docs/classes/SftpInput.html b/docs/classes/SftpInput.html index 76ed5340a..07d7a6547 100644 --- a/docs/classes/SftpInput.html +++ b/docs/classes/SftpInput.html @@ -1,5 +1,5 @@ SftpInput | @bitmovin/api-sdk

Class SftpInput

Export

SftpInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -14,28 +14,28 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Host Url or IP of the SFTP server (required)

+

Optional host

host?: string

Host Url or IP of the SFTP server (required)

Memberof

SftpInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional passive

passive?: boolean

Use passive mode. Default is true.

+

Optional passive

passive?: boolean

Use passive mode. Default is true.

Memberof

SftpInput

-

Optional password

password?: string

Your SFTP password

+

Optional password

password?: string

Your SFTP password

Memberof

SftpInput

-

Optional port

port?: number

Port to use, standard for SFTP: 22

+

Optional port

port?: number

Port to use, standard for SFTP: 22

Memberof

SftpInput

-

Readonly type

type: InputType = InputType.SFTP

Discriminator property for Input

+

Readonly type

type: InputType = InputType.SFTP

Discriminator property for Input

Memberof

SftpInput

-

Optional username

username?: string

Your SFTP Username

+

Optional username

username?: string

Your SFTP Username

Memberof

SftpInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepassivepasswordporttypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionhostidmodifiedAtnamepassivepasswordporttypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SftpOutput.html b/docs/classes/SftpOutput.html index ad8190c9b..e860f0a80 100644 --- a/docs/classes/SftpOutput.html +++ b/docs/classes/SftpOutput.html @@ -1,5 +1,5 @@ SftpOutput | @bitmovin/api-sdk

Class SftpOutput

Export

SftpOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

acl? createdAt? customData? @@ -17,34 +17,34 @@ username? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

+

Constructors

constructor

Properties

Optional acl

acl?: AclEntry[]

Deprecation notice: This property does not have any effect and will not be returned by GET endpoints

Memberof

Output

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Host Url or IP of the SFTP server (required)

+

Optional host

host?: string

Host Url or IP of the SFTP server (required)

Memberof

SftpOutput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional maxConcurrentConnections

maxConcurrentConnections?: number

Restrict maximum concurrent connections. Requires at least version 1.1.0.

+

Optional maxConcurrentConnections

maxConcurrentConnections?: number

Restrict maximum concurrent connections. Requires at least version 1.1.0.

Memberof

SftpOutput

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional passive

passive?: boolean

Use passive mode. Default is true.

+

Optional passive

passive?: boolean

Use passive mode. Default is true.

Memberof

SftpOutput

-

Optional password

password?: string

Your SFTP password

+

Optional password

password?: string

Your SFTP password

Memberof

SftpOutput

-

Optional port

port?: number

Port to use, standard for SFTP: 22

+

Optional port

port?: number

Port to use, standard for SFTP: 22

Memberof

SftpOutput

-

Optional transferVersion

transferVersion?: TransferVersion

Controls which transfer version should be used

+

Optional transferVersion

transferVersion?: TransferVersion

Controls which transfer version should be used

Memberof

SftpOutput

-

Readonly type

type: OutputType = OutputType.SFTP

Discriminator property for Output

+

Readonly type

type: OutputType = OutputType.SFTP

Discriminator property for Output

Memberof

SftpOutput

-

Optional username

username?: string

Your SFTP Username

+

Optional username

username?: string

Your SFTP Username

Memberof

SftpOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

  • AKAMAI_MSL: string
  • AKAMAI_NETSTORAGE: string
  • AZURE: string
  • CDN: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • LIVE_MEDIA_INGEST: string
  • LOCAL: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionhostidmaxConcurrentConnectionsmodifiedAtnamepassivepasswordporttransferVersiontypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_MSL: string;
    AKAMAI_NETSTORAGE: string;
    AZURE: string;
    CDN: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    LIVE_MEDIA_INGEST: string;
    LOCAL: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraclcreatedAtcustomDatadescriptionhostidmaxConcurrentConnectionsmodifiedAtnamepassivepasswordporttransferVersiontypeusername_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SidecarFile.html b/docs/classes/SidecarFile.html index 0a604e151..e19ff3063 100644 --- a/docs/classes/SidecarFile.html +++ b/docs/classes/SidecarFile.html @@ -1,6 +1,6 @@ SidecarFile | @bitmovin/api-sdk

Class SidecarFile

A file that is added to an encoding. The size limit for a sidecar file is 10 MB

Export

SidecarFile

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -13,23 +13,23 @@ outputs? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional errorMode

errorMode?: SidecarErrorMode

This defines how errors should be handled

+

Optional errorMode

errorMode?: SidecarErrorMode

This defines how errors should be handled

Memberof

SidecarFile

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

Id of input (required)

+

Optional inputId

inputId?: string

Id of input (required)

Memberof

SidecarFile

-

Optional inputPath

inputPath?: string

Path to sidecar file (required)

+

Optional inputPath

inputPath?: string

Path to sidecar file (required)

Memberof

SidecarFile

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

SidecarFile

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    WEB_VTT: string;
} = ...

Type declaration

  • WEB_VTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionerrorModeidinputIdinputPathmodifiedAtnameoutputs_discriminatorMapping_discriminatorName
\ No newline at end of file +

Optional outputs

outputs?: EncodingOutput[]

Memberof

SidecarFile

+

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    WEB_VTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionerrorModeidinputIdinputPathmodifiedAtnameoutputs_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobAccessKeyCredentials.html b/docs/classes/SimpleEncodingLiveJobAccessKeyCredentials.html index c7a56cc09..9cf30b7ff 100644 --- a/docs/classes/SimpleEncodingLiveJobAccessKeyCredentials.html +++ b/docs/classes/SimpleEncodingLiveJobAccessKeyCredentials.html @@ -1,9 +1,9 @@ SimpleEncodingLiveJobAccessKeyCredentials | @bitmovin/api-sdk

Class SimpleEncodingLiveJobAccessKeyCredentials

Export

SimpleEncodingLiveJobAccessKeyCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? secretKey? -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

The identifier of the access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

The identifier of the access key (required)

Memberof

SimpleEncodingLiveJobAccessKeyCredentials

-

Optional secretKey

secretKey?: string

The secret to be used for authentication (required)

+

Optional secretKey

secretKey?: string

The secret to be used for authentication (required)

Memberof

SimpleEncodingLiveJobAccessKeyCredentials

-

Settings

Member Visibility

Theme

On This Page

constructoraccessKeysecretKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraccessKeysecretKey
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobAzureCredentials.html b/docs/classes/SimpleEncodingLiveJobAzureCredentials.html index a6cdd0f03..6e2d32fcc 100644 --- a/docs/classes/SimpleEncodingLiveJobAzureCredentials.html +++ b/docs/classes/SimpleEncodingLiveJobAzureCredentials.html @@ -1,6 +1,6 @@ SimpleEncodingLiveJobAzureCredentials | @bitmovin/api-sdk

Class SimpleEncodingLiveJobAzureCredentials

Export

SimpleEncodingLiveJobAzureCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

key? -

Constructors

constructor

Properties

Optional key

key?: string

Azure Account Key used for authentication (required)

+

Constructors

constructor

Properties

Optional key

key?: string

Azure Account Key used for authentication (required)

Memberof

SimpleEncodingLiveJobAzureCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorkey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorkey
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobCdnOutput.html b/docs/classes/SimpleEncodingLiveJobCdnOutput.html index 93b435a0b..57aac6d00 100644 --- a/docs/classes/SimpleEncodingLiveJobCdnOutput.html +++ b/docs/classes/SimpleEncodingLiveJobCdnOutput.html @@ -1,11 +1,11 @@ SimpleEncodingLiveJobCdnOutput | @bitmovin/api-sdk

Class SimpleEncodingLiveJobCdnOutput

Export

SimpleEncodingLiveJobCdnOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

maxResolution? type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional maxResolution

maxResolution?: SimpleEncodingLiveMaxResolution

The maximum output resolution to be generated

+

Constructors

constructor

Properties

Optional maxResolution

maxResolution?: SimpleEncodingLiveMaxResolution

The maximum output resolution to be generated

Memberof

SimpleEncodingLiveJobOutput

-

Readonly type

type: SimpleEncodingLiveJobOutputType = SimpleEncodingLiveJobOutputType.CDN

Discriminator property for SimpleEncodingLiveJobOutput

+

Readonly type

type: SimpleEncodingLiveJobOutputType = SimpleEncodingLiveJobOutputType.CDN

Discriminator property for SimpleEncodingLiveJobOutput

Memberof

SimpleEncodingLiveJobCdnOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

  • CDN: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructormaxResolutiontype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructormaxResolutiontype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobCredentials.html b/docs/classes/SimpleEncodingLiveJobCredentials.html index 926c043d5..d89472f84 100644 --- a/docs/classes/SimpleEncodingLiveJobCredentials.html +++ b/docs/classes/SimpleEncodingLiveJobCredentials.html @@ -1,3 +1,3 @@ SimpleEncodingLiveJobCredentials | @bitmovin/api-sdk

Class SimpleEncodingLiveJobCredentials

Export

SimpleEncodingLiveJobCredentials

-

Hierarchy (view full)

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file +

Hierarchy (view full)

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobGcsServiceAccountCredentials.html b/docs/classes/SimpleEncodingLiveJobGcsServiceAccountCredentials.html index 470b80070..c3f50df16 100644 --- a/docs/classes/SimpleEncodingLiveJobGcsServiceAccountCredentials.html +++ b/docs/classes/SimpleEncodingLiveJobGcsServiceAccountCredentials.html @@ -1,6 +1,6 @@ SimpleEncodingLiveJobGcsServiceAccountCredentials | @bitmovin/api-sdk

Class SimpleEncodingLiveJobGcsServiceAccountCredentials

Export

SimpleEncodingLiveJobGcsServiceAccountCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

serviceAccountCredentials? -

Constructors

constructor

Properties

Optional serviceAccountCredentials

serviceAccountCredentials?: string

Service account credentials for Google (required)

+

Constructors

constructor

Properties

Optional serviceAccountCredentials

serviceAccountCredentials?: string

Service account credentials for Google (required)

Memberof

SimpleEncodingLiveJobGcsServiceAccountCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorserviceAccountCredentials
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorserviceAccountCredentials
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobInput.html b/docs/classes/SimpleEncodingLiveJobInput.html index 799cc5f1b..145b9b268 100644 --- a/docs/classes/SimpleEncodingLiveJobInput.html +++ b/docs/classes/SimpleEncodingLiveJobInput.html @@ -1,6 +1,6 @@ SimpleEncodingLiveJobInput | @bitmovin/api-sdk

Class SimpleEncodingLiveJobInput

Export

SimpleEncodingLiveJobInput

-

Constructors

constructor +

Constructors

constructor

Properties

inputType? -

Constructors

constructor

Properties

Optional inputType

inputType?: SimpleEncodingLiveJobInputType

Defines which protocol is being used as input of the live stream.

+

Constructors

constructor

Properties

Optional inputType

inputType?: SimpleEncodingLiveJobInputType

Defines which protocol is being used as input of the live stream.

Memberof

SimpleEncodingLiveJobInput

-

Settings

Member Visibility

Theme

On This Page

constructorinputType
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorinputType
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobOutput.html b/docs/classes/SimpleEncodingLiveJobOutput.html index f511c15cb..e45d17d36 100644 --- a/docs/classes/SimpleEncodingLiveJobOutput.html +++ b/docs/classes/SimpleEncodingLiveJobOutput.html @@ -1,8 +1,8 @@ SimpleEncodingLiveJobOutput | @bitmovin/api-sdk

Class SimpleEncodingLiveJobOutput

Export

SimpleEncodingLiveJobOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

maxResolution? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional maxResolution

maxResolution?: SimpleEncodingLiveMaxResolution

The maximum output resolution to be generated

+

Constructors

constructor

Properties

Optional maxResolution

maxResolution?: SimpleEncodingLiveMaxResolution

The maximum output resolution to be generated

Memberof

SimpleEncodingLiveJobOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

  • CDN: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructormaxResolution_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructormaxResolution_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobRequest.html b/docs/classes/SimpleEncodingLiveJobRequest.html index f50723970..539c6b5db 100644 --- a/docs/classes/SimpleEncodingLiveJobRequest.html +++ b/docs/classes/SimpleEncodingLiveJobRequest.html @@ -1,18 +1,18 @@ SimpleEncodingLiveJobRequest | @bitmovin/api-sdk

Class SimpleEncodingLiveJobRequest

Export

SimpleEncodingLiveJobRequest

-

Constructors

constructor +

Constructors

constructor

Properties

cloudRegion? encodingProfile? input? name? outputs? -

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: SimpleEncodingLiveCloudRegion

The cloud region that will be used for the live encoding. This value has to be set.

+

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: SimpleEncodingLiveCloudRegion

The cloud region that will be used for the live encoding. This value has to be set.

Memberof

SimpleEncodingLiveJobRequest

-

Optional encodingProfile

encodingProfile?: SimpleEncodingLiveProfile

The profile that will be used for the live encoding.

+

Optional encodingProfile

encodingProfile?: SimpleEncodingLiveProfile

The profile that will be used for the live encoding.

Memberof

SimpleEncodingLiveJobRequest

-

Optional input

input?: SimpleEncodingLiveJobInput

Please take a look at the documentation (required)

+

Optional input

input?: SimpleEncodingLiveJobInput

Please take a look at the documentation (required)

Memberof

SimpleEncodingLiveJobRequest

-

Optional name

name?: string

This property will be used for naming the encoding.

+

Optional name

name?: string

This property will be used for naming the encoding.

Memberof

SimpleEncodingLiveJobRequest

-

Optional outputs

outputs?: SimpleEncodingLiveJobOutput[]

Please take a look at the documentation (required)

+

Optional outputs

outputs?: SimpleEncodingLiveJobOutput[]

Please take a look at the documentation (required)

Memberof

SimpleEncodingLiveJobRequest

-

Settings

Member Visibility

Theme

On This Page

constructorcloudRegionencodingProfileinputnameoutputs
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcloudRegionencodingProfileinputnameoutputs
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobResponse.html b/docs/classes/SimpleEncodingLiveJobResponse.html index fa36974b5..077ec08f6 100644 --- a/docs/classes/SimpleEncodingLiveJobResponse.html +++ b/docs/classes/SimpleEncodingLiveJobResponse.html @@ -1,5 +1,5 @@ SimpleEncodingLiveJobResponse | @bitmovin/api-sdk

Class SimpleEncodingLiveJobResponse

Export

SimpleEncodingLiveJobResponse

-

Constructors

constructor +

Constructors

constructor

Properties

cloudRegion? createdAt? encoderIp? @@ -13,28 +13,28 @@ outputs? status? streamKey? -

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: SimpleEncodingLiveCloudRegion

The cloud region that will be used for the live encoding

+

Constructors

constructor

Properties

Optional cloudRegion

cloudRegion?: SimpleEncodingLiveCloudRegion

The cloud region that will be used for the live encoding

Memberof

SimpleEncodingLiveJobResponse

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

SimpleEncodingLiveJobResponse

-

Optional encoderIp

encoderIp?: string

The IP address of the encoder for this job request. This is only returned once the job execution has been successful and the encoding could be started. Ingest is expected to be sent to this IP address.

+

Optional encoderIp

encoderIp?: string

The IP address of the encoder for this job request. This is only returned once the job execution has been successful and the encoding could be started. Ingest is expected to be sent to this IP address.

Memberof

SimpleEncodingLiveJobResponse

-

Optional encodingId

encodingId?: string

The identifier of the encoding that has been created based on the job request. This is only returned once the job execution has been successful and the encoding could be started.

+

Optional encodingId

encodingId?: string

The identifier of the encoding that has been created based on the job request. This is only returned once the job execution has been successful and the encoding could be started.

Memberof

SimpleEncodingLiveJobResponse

-

Optional encodingProfile

encodingProfile?: SimpleEncodingLiveProfile

The profile that will be used for the live encoding.

+

Optional encodingProfile

encodingProfile?: SimpleEncodingLiveProfile

The profile that will be used for the live encoding.

Memberof

SimpleEncodingLiveJobResponse

-

Optional errors

errors?: SimpleEncodingVodJobErrors[]

Describes all the errors in cases the status of the job is 'error'.

+

Optional errors

errors?: SimpleEncodingVodJobErrors[]

Describes all the errors in cases the status of the job is 'error'.

Memberof

SimpleEncodingLiveJobResponse

-

Optional id

id?: string

The identifier of the Simple Encoding Live Job

+

Optional id

id?: string

The identifier of the Simple Encoding Live Job

Memberof

SimpleEncodingLiveJobResponse

-

Optional input

input?: SimpleEncodingLiveJobInput

Memberof

SimpleEncodingLiveJobResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The job is updated for example when the status changes

+

Optional input

input?: SimpleEncodingLiveJobInput

Memberof

SimpleEncodingLiveJobResponse

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The job is updated for example when the status changes

Memberof

SimpleEncodingLiveJobResponse

-

Optional name

name?: string

This property will be used for naming the encoding and the manifests.

+

Optional name

name?: string

This property will be used for naming the encoding and the manifests.

Memberof

SimpleEncodingLiveJobResponse

-

Optional outputs

outputs?: SimpleEncodingLiveJobOutput[]

Memberof

SimpleEncodingLiveJobResponse

-

Optional status

status?: SimpleEncodingLiveJobStatus

The current status of the Simple Encoding Live Job

+

Optional outputs

outputs?: SimpleEncodingLiveJobOutput[]

Memberof

SimpleEncodingLiveJobResponse

+

Optional status

status?: SimpleEncodingLiveJobStatus

The current status of the Simple Encoding Live Job

Memberof

SimpleEncodingLiveJobResponse

-

Optional streamKey

streamKey?: string

Stream key of the live encoder

+

Optional streamKey

streamKey?: string

Stream key of the live encoder

Memberof

SimpleEncodingLiveJobResponse

-

Settings

Member Visibility

Theme

On This Page

constructorcloudRegioncreatedAtencoderIpencodingIdencodingProfileerrorsidinputmodifiedAtnameoutputsstatusstreamKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcloudRegioncreatedAtencoderIpencodingIdencodingProfileerrorsidinputmodifiedAtnameoutputsstatusstreamKey
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobS3RoleBasedCredentials.html b/docs/classes/SimpleEncodingLiveJobS3RoleBasedCredentials.html index 3577f1dc5..656e40359 100644 --- a/docs/classes/SimpleEncodingLiveJobS3RoleBasedCredentials.html +++ b/docs/classes/SimpleEncodingLiveJobS3RoleBasedCredentials.html @@ -1,9 +1,9 @@ SimpleEncodingLiveJobS3RoleBasedCredentials | @bitmovin/api-sdk

Class SimpleEncodingLiveJobS3RoleBasedCredentials

Export

SimpleEncodingLiveJobS3RoleBasedCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

roleArn? useExternalId? -

Constructors

constructor

Properties

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. More details can be found here (required)

+

Constructors

constructor

Properties

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. More details can be found here (required)

Memberof

SimpleEncodingLiveJobS3RoleBasedCredentials

-

Optional useExternalId

useExternalId?: boolean

Defines if the organization ID has to be used as externalId when assuming the role. More details can be found here

+

Optional useExternalId

useExternalId?: boolean

Defines if the organization ID has to be used as externalId when assuming the role. More details can be found here

Memberof

SimpleEncodingLiveJobS3RoleBasedCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorroleArnuseExternalId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorroleArnuseExternalId
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobUrlOutput.html b/docs/classes/SimpleEncodingLiveJobUrlOutput.html index a88ed957a..5b57539e4 100644 --- a/docs/classes/SimpleEncodingLiveJobUrlOutput.html +++ b/docs/classes/SimpleEncodingLiveJobUrlOutput.html @@ -1,5 +1,5 @@ SimpleEncodingLiveJobUrlOutput | @bitmovin/api-sdk

Class SimpleEncodingLiveJobUrlOutput

Export

SimpleEncodingLiveJobUrlOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

credentials? makePublic? maxResolution? @@ -7,14 +7,14 @@ url? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional credentials

credentials?: SimpleEncodingLiveJobCredentials

Credentials to be used for authentication and accessing the folder.

+

Constructors

constructor

Properties

Optional credentials

credentials?: SimpleEncodingLiveJobCredentials

Credentials to be used for authentication and accessing the folder.

Memberof

SimpleEncodingLiveJobUrlOutput

-

Optional makePublic

makePublic?: boolean

Indicates if the output should be publically available so that playback immediately works over the internet. Note that not every storage provider supports public output, in this case the flag will be ignored (e.g., Akamai NetStorage). It might forbidden by some storage configuration to make files public, for example an S3 buckets can be configured to disallow public access. In this case set it to false.

+

Optional makePublic

makePublic?: boolean

Indicates if the output should be publically available so that playback immediately works over the internet. Note that not every storage provider supports public output, in this case the flag will be ignored (e.g., Akamai NetStorage). It might forbidden by some storage configuration to make files public, for example an S3 buckets can be configured to disallow public access. In this case set it to false.

Memberof

SimpleEncodingLiveJobUrlOutput

-

Optional maxResolution

maxResolution?: SimpleEncodingLiveMaxResolution

The maximum output resolution to be generated

+

Optional maxResolution

maxResolution?: SimpleEncodingLiveMaxResolution

The maximum output resolution to be generated

Memberof

SimpleEncodingLiveJobOutput

-

Readonly type

type: SimpleEncodingLiveJobOutputType = SimpleEncodingLiveJobOutputType.URL

Discriminator property for SimpleEncodingLiveJobOutput

+

Readonly type

type: SimpleEncodingLiveJobOutputType = SimpleEncodingLiveJobOutputType.URL

Discriminator property for SimpleEncodingLiveJobOutput

Memberof

SimpleEncodingLiveJobUrlOutput

-

Optional url

url?: string

Define a URL pointing to a folder which will be used to upload the encoded assets. The output folder structure used looks the following way:

http://host/my-folder

  • /video
    • /{width}x{height}_{bitrate}/ (multiple subfolders containing different output renditions)
  • /audio
  • /index.m3u8 (HLS manifest file)
  • /stream.mpd (DASH manifest file)
Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocals/storage systems. S3: * s3://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/ It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/ It is required to provide username/password credentials for authentication. (required)

+

Optional url

url?: string

Define a URL pointing to a folder which will be used to upload the encoded assets. The output folder structure used looks the following way:

http://host/my-folder

  • /video
    • /{width}x{height}_{bitrate}/ (multiple subfolders containing different output renditions)
  • /audio
  • /index.m3u8 (HLS manifest file)
  • /stream.mpd (DASH manifest file)
Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocals/storage systems. S3: * s3://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/ It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/ It is required to provide username/password credentials for authentication. (required)

Memberof

SimpleEncodingLiveJobUrlOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

  • CDN: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcredentialsmakePublicmaxResolutiontypeurl_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcredentialsmakePublicmaxResolutiontypeurl_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingLiveJobUsernamePasswordCredentials.html b/docs/classes/SimpleEncodingLiveJobUsernamePasswordCredentials.html index f29f5672c..b3bc88212 100644 --- a/docs/classes/SimpleEncodingLiveJobUsernamePasswordCredentials.html +++ b/docs/classes/SimpleEncodingLiveJobUsernamePasswordCredentials.html @@ -1,9 +1,9 @@ SimpleEncodingLiveJobUsernamePasswordCredentials | @bitmovin/api-sdk

Class SimpleEncodingLiveJobUsernamePasswordCredentials

Export

SimpleEncodingLiveJobUsernamePasswordCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

password? username? -

Constructors

constructor

Properties

Optional password

password?: string

The password to be used for authentication (required)

+

Constructors

constructor

Properties

Optional password

password?: string

The password to be used for authentication (required)

Memberof

SimpleEncodingLiveJobUsernamePasswordCredentials

-

Optional username

username?: string

The username to be used for authentication. (required)

+

Optional username

username?: string

The username to be used for authentication. (required)

Memberof

SimpleEncodingLiveJobUsernamePasswordCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorpasswordusername
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpasswordusername
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobAccessKeyCredentials.html b/docs/classes/SimpleEncodingVodJobAccessKeyCredentials.html index 39f3ed6e4..5dcdf0fde 100644 --- a/docs/classes/SimpleEncodingVodJobAccessKeyCredentials.html +++ b/docs/classes/SimpleEncodingVodJobAccessKeyCredentials.html @@ -1,9 +1,9 @@ SimpleEncodingVodJobAccessKeyCredentials | @bitmovin/api-sdk

Class SimpleEncodingVodJobAccessKeyCredentials

Export

SimpleEncodingVodJobAccessKeyCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessKey? secretKey? -

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

The identifier of the access key (required)

+

Constructors

constructor

Properties

Optional accessKey

accessKey?: string

The identifier of the access key (required)

Memberof

SimpleEncodingVodJobAccessKeyCredentials

-

Optional secretKey

secretKey?: string

The secret to be used for authentication (required)

+

Optional secretKey

secretKey?: string

The secret to be used for authentication (required)

Memberof

SimpleEncodingVodJobAccessKeyCredentials

-

Settings

Member Visibility

Theme

On This Page

constructoraccessKeysecretKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraccessKeysecretKey
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobAzureCredentials.html b/docs/classes/SimpleEncodingVodJobAzureCredentials.html index e55b322a3..75023fc26 100644 --- a/docs/classes/SimpleEncodingVodJobAzureCredentials.html +++ b/docs/classes/SimpleEncodingVodJobAzureCredentials.html @@ -1,6 +1,6 @@ SimpleEncodingVodJobAzureCredentials | @bitmovin/api-sdk

Class SimpleEncodingVodJobAzureCredentials

Export

SimpleEncodingVodJobAzureCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

key? -

Constructors

constructor

Properties

Optional key

key?: string

Azure Account Key used for authentication (required)

+

Constructors

constructor

Properties

Optional key

key?: string

Azure Account Key used for authentication (required)

Memberof

SimpleEncodingVodJobAzureCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorkey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorkey
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobCdnOutput.html b/docs/classes/SimpleEncodingVodJobCdnOutput.html index df2d25084..73874f1d4 100644 --- a/docs/classes/SimpleEncodingVodJobCdnOutput.html +++ b/docs/classes/SimpleEncodingVodJobCdnOutput.html @@ -1,14 +1,14 @@ SimpleEncodingVodJobCdnOutput | @bitmovin/api-sdk

Class SimpleEncodingVodJobCdnOutput

Export

SimpleEncodingVodJobCdnOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

artifacts? maxResolution? type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional artifacts

artifacts?: SimpleEncodingVodJobOutputArtifact[]

List of artifacts created by the encoding job. Artifacts are files essential for playback of the generated content, e.g. manifests.

+

Constructors

constructor

Properties

Optional artifacts

artifacts?: SimpleEncodingVodJobOutputArtifact[]

List of artifacts created by the encoding job. Artifacts are files essential for playback of the generated content, e.g. manifests.

Memberof

SimpleEncodingVodJobOutput

-

Optional maxResolution

maxResolution?: SimpleEncodingLiveMaxResolution

The maximum output resolution to be generated

+

Optional maxResolution

maxResolution?: SimpleEncodingLiveMaxResolution

The maximum output resolution to be generated

Memberof

SimpleEncodingVodJobCdnOutput

-

Readonly type

type: SimpleEncodingVodJobOutputType = SimpleEncodingVodJobOutputType.CDN

Discriminator property for SimpleEncodingVodJobOutput

+

Readonly type

type: SimpleEncodingVodJobOutputType = SimpleEncodingVodJobOutputType.CDN

Discriminator property for SimpleEncodingVodJobOutput

Memberof

SimpleEncodingVodJobCdnOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

  • CDN: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorartifactsmaxResolutiontype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorartifactsmaxResolutiontype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobCredentials.html b/docs/classes/SimpleEncodingVodJobCredentials.html index 34b4268f8..3de795656 100644 --- a/docs/classes/SimpleEncodingVodJobCredentials.html +++ b/docs/classes/SimpleEncodingVodJobCredentials.html @@ -1,3 +1,3 @@ SimpleEncodingVodJobCredentials | @bitmovin/api-sdk

Class SimpleEncodingVodJobCredentials

Export

SimpleEncodingVodJobCredentials

-

Hierarchy (view full)

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file +

Hierarchy (view full)

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobDirectFileUploadInput.html b/docs/classes/SimpleEncodingVodJobDirectFileUploadInput.html index be73c55bd..12124770e 100644 --- a/docs/classes/SimpleEncodingVodJobDirectFileUploadInput.html +++ b/docs/classes/SimpleEncodingVodJobDirectFileUploadInput.html @@ -1,17 +1,17 @@ SimpleEncodingVodJobDirectFileUploadInput | @bitmovin/api-sdk

Class SimpleEncodingVodJobDirectFileUploadInput

Export

SimpleEncodingVodJobDirectFileUploadInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

inputId? inputType? language? type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional inputId

inputId?: string

Id of a DirectFileUploadInput (required)

+

Constructors

constructor

Properties

Optional inputId

inputId?: string

Id of a DirectFileUploadInput (required)

Memberof

SimpleEncodingVodJobDirectFileUploadInput

-

Optional inputType

inputType?: SimpleEncodingVodJobInputType

Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams. Note that when defining video and audio inputs, you can either - add one single input without inputType, in which case that source file must contain a video stream and (if you want audio) one audio stream, or - add one single input with inputType=VIDEO and (if you want audio) one or more inputs with inputType=AUDIO (each containing one audio stream) Other combinations are not valid.

+

Optional inputType

inputType?: SimpleEncodingVodJobInputType

Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams. Note that when defining video and audio inputs, you can either - add one single input without inputType, in which case that source file must contain a video stream and (if you want audio) one audio stream, or - add one single input with inputType=VIDEO and (if you want audio) one or more inputs with inputType=AUDIO (each containing one audio stream) Other combinations are not valid.

Memberof

SimpleEncodingVodJobDirectFileUploadInput

-

Optional language

language?: string

The language of the audio track, the subtitles, or closed captions file. The language code must be compliant with BCP 47. This property is mandatory if the input provided is of type SUBTITLES or CLOSED_CAPTIONS and recommended for input type AUDIO and an input that does not specify an input type (combined audio and video). If an audio input does not specify the language, it is defaulted to und (undefined).

+

Optional language

language?: string

The language of the audio track, the subtitles, or closed captions file. The language code must be compliant with BCP 47. This property is mandatory if the input provided is of type SUBTITLES or CLOSED_CAPTIONS and recommended for input type AUDIO and an input that does not specify an input type (combined audio and video). If an audio input does not specify the language, it is defaulted to und (undefined).

Memberof

SimpleEncodingVodJobDirectFileUploadInput

-

Readonly type

type: SimpleEncodingVodJobInputSourceType = SimpleEncodingVodJobInputSourceType.DIRECT_FILE_UPLOAD

Discriminator property for SimpleEncodingVodJobInput

+

Readonly type

type: SimpleEncodingVodJobInputSourceType = SimpleEncodingVodJobInputSourceType.DIRECT_FILE_UPLOAD

Discriminator property for SimpleEncodingVodJobInput

Memberof

SimpleEncodingVodJobDirectFileUploadInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    DIRECT_FILE_UPLOAD: string;
    URL: string;
} = ...

Type declaration

  • DIRECT_FILE_UPLOAD: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorinputIdinputTypelanguagetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    DIRECT_FILE_UPLOAD: string;
    URL: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorinputIdinputTypelanguagetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobErrors.html b/docs/classes/SimpleEncodingVodJobErrors.html index ab375648c..4417bab1a 100644 --- a/docs/classes/SimpleEncodingVodJobErrors.html +++ b/docs/classes/SimpleEncodingVodJobErrors.html @@ -1,12 +1,12 @@ SimpleEncodingVodJobErrors | @bitmovin/api-sdk

Class SimpleEncodingVodJobErrors

Export

SimpleEncodingVodJobErrors

-

Constructors

constructor +

Constructors

constructor

Properties

details? errorCode? message? -

Constructors

constructor

Properties

Optional details

details?: string

Additional details of the error if available.

+

Constructors

constructor

Properties

Optional details

details?: string

Additional details of the error if available.

Memberof

SimpleEncodingVodJobErrors

-

Optional errorCode

errorCode?: string

Stable code that identifies the error type.

+

Optional errorCode

errorCode?: string

Stable code that identifies the error type.

Memberof

SimpleEncodingVodJobErrors

-

Optional message

message?: string

Human readable description of the error.

+

Optional message

message?: string

Human readable description of the error.

Memberof

SimpleEncodingVodJobErrors

-

Settings

Member Visibility

Theme

On This Page

constructordetailserrorCodemessage
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordetailserrorCodemessage
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobGcsServiceAccountCredentials.html b/docs/classes/SimpleEncodingVodJobGcsServiceAccountCredentials.html index 6bdf5713d..453634916 100644 --- a/docs/classes/SimpleEncodingVodJobGcsServiceAccountCredentials.html +++ b/docs/classes/SimpleEncodingVodJobGcsServiceAccountCredentials.html @@ -1,6 +1,6 @@ SimpleEncodingVodJobGcsServiceAccountCredentials | @bitmovin/api-sdk

Class SimpleEncodingVodJobGcsServiceAccountCredentials

Export

SimpleEncodingVodJobGcsServiceAccountCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

serviceAccountCredentials? -

Constructors

constructor

Properties

Optional serviceAccountCredentials

serviceAccountCredentials?: string

Service account credentials for Google (required)

+

Constructors

constructor

Properties

Optional serviceAccountCredentials

serviceAccountCredentials?: string

Service account credentials for Google (required)

Memberof

SimpleEncodingVodJobGcsServiceAccountCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorserviceAccountCredentials
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorserviceAccountCredentials
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobInput.html b/docs/classes/SimpleEncodingVodJobInput.html index 63515f6a1..51d5a76a8 100644 --- a/docs/classes/SimpleEncodingVodJobInput.html +++ b/docs/classes/SimpleEncodingVodJobInput.html @@ -1,5 +1,5 @@ SimpleEncodingVodJobInput | @bitmovin/api-sdk

Class SimpleEncodingVodJobInput

Export

SimpleEncodingVodJobInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

_discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    DIRECT_FILE_UPLOAD: string;
    URL: string;
} = ...

Type declaration

  • DIRECT_FILE_UPLOAD: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructor_discriminatorMapping_discriminatorName
\ No newline at end of file +

Constructors

constructor

Properties

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    DIRECT_FILE_UPLOAD: string;
    URL: string;
} = ...

Type declaration

  • DIRECT_FILE_UPLOAD: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructor_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobOptions.html b/docs/classes/SimpleEncodingVodJobOptions.html index 7ee832477..f59ddb917 100644 --- a/docs/classes/SimpleEncodingVodJobOptions.html +++ b/docs/classes/SimpleEncodingVodJobOptions.html @@ -1,6 +1,6 @@ SimpleEncodingVodJobOptions | @bitmovin/api-sdk

Class SimpleEncodingVodJobOptions

Export

SimpleEncodingVodJobOptions

-

Constructors

constructor +

Constructors

constructor

Properties

singleFileOutput? -

Constructors

constructor

Properties

Optional singleFileOutput

singleFileOutput?: boolean

Defines if the job should additionally produce a single file as output (e.g., an MP4) for every rendition the Per-Title algorithm produces. This can be useful to provide customers with features such as downloading of videos for different screen sizes. The single file contains both audio and video streams along the segmented output. Note that currently we do not include subtitles in this file.

+

Constructors

constructor

Properties

Optional singleFileOutput

singleFileOutput?: boolean

Defines if the job should additionally produce a single file as output (e.g., an MP4) for every rendition the Per-Title algorithm produces. This can be useful to provide customers with features such as downloading of videos for different screen sizes. The single file contains both audio and video streams along the segmented output. Note that currently we do not include subtitles in this file.

Memberof

SimpleEncodingVodJobOptions

-

Settings

Member Visibility

Theme

On This Page

constructorsingleFileOutput
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorsingleFileOutput
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobOutput.html b/docs/classes/SimpleEncodingVodJobOutput.html index 1e1520bac..c6059283b 100644 --- a/docs/classes/SimpleEncodingVodJobOutput.html +++ b/docs/classes/SimpleEncodingVodJobOutput.html @@ -1,8 +1,8 @@ SimpleEncodingVodJobOutput | @bitmovin/api-sdk

Class SimpleEncodingVodJobOutput

Export

SimpleEncodingVodJobOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

artifacts? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional artifacts

artifacts?: SimpleEncodingVodJobOutputArtifact[]

List of artifacts created by the encoding job. Artifacts are files essential for playback of the generated content, e.g. manifests.

+

Constructors

constructor

Properties

Optional artifacts

artifacts?: SimpleEncodingVodJobOutputArtifact[]

List of artifacts created by the encoding job. Artifacts are files essential for playback of the generated content, e.g. manifests.

Memberof

SimpleEncodingVodJobOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

  • CDN: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorartifacts_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorartifacts_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobOutputArtifact.html b/docs/classes/SimpleEncodingVodJobOutputArtifact.html index 56a793bff..0f89ca2e7 100644 --- a/docs/classes/SimpleEncodingVodJobOutputArtifact.html +++ b/docs/classes/SimpleEncodingVodJobOutputArtifact.html @@ -1,9 +1,9 @@ SimpleEncodingVodJobOutputArtifact | @bitmovin/api-sdk

Class SimpleEncodingVodJobOutputArtifact

Export

SimpleEncodingVodJobOutputArtifact

-

Constructors

constructor +

Constructors

constructor

Properties

name? value? -

Constructors

constructor

Properties

Optional name

name?: string

Name of the artifact. Currently we provide the URL of the HLS manifest with name 'HLS_MANIFEST_URL' and the URL of the DASH manifest with name 'DASH_MANIFEST_URL'

+

Constructors

constructor

Properties

Optional name

name?: string

Name of the artifact. Currently we provide the URL of the HLS manifest with name 'HLS_MANIFEST_URL' and the URL of the DASH manifest with name 'DASH_MANIFEST_URL'

Memberof

SimpleEncodingVodJobOutputArtifact

-

Optional value

value?: string

A string value described by the 'name' property. Typically this is an absolute URL pointing to a file on the output you specified for the encoding job. The protocol depends on the type of output: "s3://" for AWS S3,"gcs://" for Google Cloud Storage, "https://" for Azure Blob Storage and Akamai NetStorage )

+

Optional value

value?: string

A string value described by the 'name' property. Typically this is an absolute URL pointing to a file on the output you specified for the encoding job. The protocol depends on the type of output: "s3://" for AWS S3,"gcs://" for Google Cloud Storage, "https://" for Azure Blob Storage and Akamai NetStorage )

Memberof

SimpleEncodingVodJobOutputArtifact

-

Settings

Member Visibility

Theme

On This Page

constructornamevalue
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructornamevalue
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobRequest.html b/docs/classes/SimpleEncodingVodJobRequest.html index 199b6f34c..3a05b933a 100644 --- a/docs/classes/SimpleEncodingVodJobRequest.html +++ b/docs/classes/SimpleEncodingVodJobRequest.html @@ -1,18 +1,18 @@ SimpleEncodingVodJobRequest | @bitmovin/api-sdk

Class SimpleEncodingVodJobRequest

Export

SimpleEncodingVodJobRequest

-

Constructors

constructor +

Constructors

constructor

Properties

encodingTemplate? inputs? name? options? outputs? -

Constructors

constructor

Properties

Optional encodingTemplate

encodingTemplate?: EncodingTemplate

The template that will be used for the encoding.

+

Constructors

constructor

Properties

Optional encodingTemplate

encodingTemplate?: EncodingTemplate

The template that will be used for the encoding.

Memberof

SimpleEncodingVodJobRequest

-

Optional inputs

inputs?: SimpleEncodingVodJobInput[]

Please take a look at the documentation (required)

+

Optional inputs

inputs?: SimpleEncodingVodJobInput[]

Please take a look at the documentation (required)

Memberof

SimpleEncodingVodJobRequest

-

Optional name

name?: string

This property will be used for naming the encoding and the manifests.

+

Optional name

name?: string

This property will be used for naming the encoding and the manifests.

Memberof

SimpleEncodingVodJobRequest

-

Optional options

options?: SimpleEncodingVodJobOptions

Options to customize the Simple Encoding Job

+

Optional options

options?: SimpleEncodingVodJobOptions

Options to customize the Simple Encoding Job

Memberof

SimpleEncodingVodJobRequest

-

Optional outputs

outputs?: SimpleEncodingVodJobOutput[]

Please take a look at the documentation (required)

+

Optional outputs

outputs?: SimpleEncodingVodJobOutput[]

Please take a look at the documentation (required)

Memberof

SimpleEncodingVodJobRequest

-

Settings

Member Visibility

Theme

On This Page

constructorencodingTemplateinputsnameoptionsoutputs
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorencodingTemplateinputsnameoptionsoutputs
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobResponse.html b/docs/classes/SimpleEncodingVodJobResponse.html index 2e4ba0c37..b00fe1229 100644 --- a/docs/classes/SimpleEncodingVodJobResponse.html +++ b/docs/classes/SimpleEncodingVodJobResponse.html @@ -1,5 +1,5 @@ SimpleEncodingVodJobResponse | @bitmovin/api-sdk

Class SimpleEncodingVodJobResponse

Export

SimpleEncodingVodJobResponse

-

Constructors

constructor +

Constructors

constructor

Properties

createdAt? encodingId? encodingTemplate? @@ -11,24 +11,24 @@ options? outputs? status? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

SimpleEncodingVodJobResponse

-

Optional encodingId

encodingId?: string

The identifier of the encoding that has been created based on the job request. This is only returned once the job execution has been successful and the encoding could be started.

+

Optional encodingId

encodingId?: string

The identifier of the encoding that has been created based on the job request. This is only returned once the job execution has been successful and the encoding could be started.

Memberof

SimpleEncodingVodJobResponse

-

Optional encodingTemplate

encodingTemplate?: EncodingTemplate

The template that has been used for the encoding.

+

Optional encodingTemplate

encodingTemplate?: EncodingTemplate

The template that has been used for the encoding.

Memberof

SimpleEncodingVodJobResponse

-

Optional errors

errors?: SimpleEncodingVodJobErrors[]

Describes all the errors in cases the status of the job is 'error'.

+

Optional errors

errors?: SimpleEncodingVodJobErrors[]

Describes all the errors in cases the status of the job is 'error'.

Memberof

SimpleEncodingVodJobResponse

-

Optional id

id?: string

The identifier of the Simple Encoding VOD Job

+

Optional id

id?: string

The identifier of the Simple Encoding VOD Job

Memberof

SimpleEncodingVodJobResponse

-

Optional inputs

inputs?: SimpleEncodingVodJobInput[]

Memberof

SimpleEncodingVodJobResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The job is updated for example when the status changes

+

Optional inputs

inputs?: SimpleEncodingVodJobInput[]

Memberof

SimpleEncodingVodJobResponse

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The job is updated for example when the status changes

Memberof

SimpleEncodingVodJobResponse

-

Optional name

name?: string

This property will be used for naming the encoding and the manifests.

+

Optional name

name?: string

This property will be used for naming the encoding and the manifests.

Memberof

SimpleEncodingVodJobResponse

-

Optional options

options?: SimpleEncodingVodJobOptions

Options to customize the Simple Encoding Job

+

Optional options

options?: SimpleEncodingVodJobOptions

Options to customize the Simple Encoding Job

Memberof

SimpleEncodingVodJobResponse

-

Optional outputs

outputs?: SimpleEncodingVodJobOutput[]

Memberof

SimpleEncodingVodJobResponse

-

Optional status

status?: SimpleEncodingVodJobStatus

The current status of the Simple Encoding VOD Job

+

Optional outputs

outputs?: SimpleEncodingVodJobOutput[]

Memberof

SimpleEncodingVodJobResponse

+

Optional status

status?: SimpleEncodingVodJobStatus

The current status of the Simple Encoding VOD Job

Memberof

SimpleEncodingVodJobResponse

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtencodingIdencodingTemplateerrorsidinputsmodifiedAtnameoptionsoutputsstatus
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtencodingIdencodingTemplateerrorsidinputsmodifiedAtnameoptionsoutputsstatus
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobS3RoleBasedCredentials.html b/docs/classes/SimpleEncodingVodJobS3RoleBasedCredentials.html index 3bdf0be28..dda8c7331 100644 --- a/docs/classes/SimpleEncodingVodJobS3RoleBasedCredentials.html +++ b/docs/classes/SimpleEncodingVodJobS3RoleBasedCredentials.html @@ -1,9 +1,9 @@ SimpleEncodingVodJobS3RoleBasedCredentials | @bitmovin/api-sdk

Class SimpleEncodingVodJobS3RoleBasedCredentials

Export

SimpleEncodingVodJobS3RoleBasedCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

roleArn? useExternalId? -

Constructors

constructor

Properties

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. More details can be found here (required)

+

Constructors

constructor

Properties

Optional roleArn

roleArn?: string

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. More details can be found here (required)

Memberof

SimpleEncodingVodJobS3RoleBasedCredentials

-

Optional useExternalId

useExternalId?: boolean

Defines if the organization ID has to be used as externalId when assuming the role. More details can be found here

+

Optional useExternalId

useExternalId?: boolean

Defines if the organization ID has to be used as externalId when assuming the role. More details can be found here

Memberof

SimpleEncodingVodJobS3RoleBasedCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorroleArnuseExternalId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorroleArnuseExternalId
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobUrlInput.html b/docs/classes/SimpleEncodingVodJobUrlInput.html index dd2e0b37b..c5ae8c9df 100644 --- a/docs/classes/SimpleEncodingVodJobUrlInput.html +++ b/docs/classes/SimpleEncodingVodJobUrlInput.html @@ -1,5 +1,5 @@ SimpleEncodingVodJobUrlInput | @bitmovin/api-sdk

Class SimpleEncodingVodJobUrlInput

Export

SimpleEncodingVodJobUrlInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

credentials? inputType? language? @@ -7,14 +7,14 @@ url? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional credentials

credentials?: SimpleEncodingVodJobCredentials

Credentials to be used for authentication and accessing the file. Check out the examples on how to define the credentials correctly.

+

Constructors

constructor

Properties

Optional credentials

credentials?: SimpleEncodingVodJobCredentials

Credentials to be used for authentication and accessing the file. Check out the examples on how to define the credentials correctly.

Memberof

SimpleEncodingVodJobUrlInput

-

Optional inputType

inputType?: SimpleEncodingVodJobInputType

Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams. Note that when defining video and audio inputs, you can either - add one single input without inputType, in which case that source file must contain a video stream and (if you want audio) one audio stream, or - add one single input with inputType=VIDEO and (if you want audio) one or more inputs with inputType=AUDIO (each containing one audio stream) Other combinations are not valid.

+

Optional inputType

inputType?: SimpleEncodingVodJobInputType

Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams. Note that when defining video and audio inputs, you can either - add one single input without inputType, in which case that source file must contain a video stream and (if you want audio) one audio stream, or - add one single input with inputType=VIDEO and (if you want audio) one or more inputs with inputType=AUDIO (each containing one audio stream) Other combinations are not valid.

Memberof

SimpleEncodingVodJobUrlInput

-

Optional language

language?: string

The language of the audio track, the subtitles, or closed captions file. The language code must be compliant with BCP 47. This property is mandatory if the input provided is of type SUBTITLES or CLOSED_CAPTIONS and recommended for input type AUDIO and an input that does not specify an input type (combined audio and video). If an audio input does not specify the language, it is defaulted to und (undefined).

+

Optional language

language?: string

The language of the audio track, the subtitles, or closed captions file. The language code must be compliant with BCP 47. This property is mandatory if the input provided is of type SUBTITLES or CLOSED_CAPTIONS and recommended for input type AUDIO and an input that does not specify an input type (combined audio and video). If an audio input does not specify the language, it is defaulted to und (undefined).

Memberof

SimpleEncodingVodJobUrlInput

-

Readonly type

type: SimpleEncodingVodJobInputSourceType = SimpleEncodingVodJobInputSourceType.URL

Discriminator property for SimpleEncodingVodJobInput

+

Readonly type

type: SimpleEncodingVodJobInputSourceType = SimpleEncodingVodJobInputSourceType.URL

Discriminator property for SimpleEncodingVodJobInput

Memberof

SimpleEncodingVodJobUrlInput

-

Optional url

url?: string

Define a URL pointing to the asset that should be encoded. The URL has to point to a file. Currently the following protocols/storages systems are supported: HTTP(S), (S)FTP, S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocols/storage systems. --- HTTP and HTTPS: * http://<host>[:<port>]/path/file.mp4 * https://<host>[:<port>]/path/file.mp4 The port is defaulted to 80 if it's not provided. If the content is secured by Basic Authentication please provide corresponding credentials. FTP and SFTP: * ftp://<host>[:<port>]/path/file.mp4 * sftp://<host>[:<port>]/path/file.mp4 The port is defaulted to 21 (ftp) or 22 (sftp) if it's not provided. If the content is secured please provide corresponding credentials. S3: * s3://<my-bucket>/path/file.mp4 Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/file.mp4 Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/file.mp4 It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/file.mp4 It is required to provide username/password credentials for authentication. (required)

+

Optional url

url?: string

Define a URL pointing to the asset that should be encoded. The URL has to point to a file. Currently the following protocols/storages systems are supported: HTTP(S), (S)FTP, S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocols/storage systems. --- HTTP and HTTPS: * http://<host>[:<port>]/path/file.mp4 * https://<host>[:<port>]/path/file.mp4 The port is defaulted to 80 if it's not provided. If the content is secured by Basic Authentication please provide corresponding credentials. FTP and SFTP: * ftp://<host>[:<port>]/path/file.mp4 * sftp://<host>[:<port>]/path/file.mp4 The port is defaulted to 21 (ftp) or 22 (sftp) if it's not provided. If the content is secured please provide corresponding credentials. S3: * s3://<my-bucket>/path/file.mp4 Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/file.mp4 Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/file.mp4 It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/file.mp4 It is required to provide username/password credentials for authentication. (required)

Memberof

SimpleEncodingVodJobUrlInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    DIRECT_FILE_UPLOAD: string;
    URL: string;
} = ...

Type declaration

  • DIRECT_FILE_UPLOAD: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcredentialsinputTypelanguagetypeurl_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    DIRECT_FILE_UPLOAD: string;
    URL: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcredentialsinputTypelanguagetypeurl_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobUrlOutput.html b/docs/classes/SimpleEncodingVodJobUrlOutput.html index 603fedf32..cf2b5b141 100644 --- a/docs/classes/SimpleEncodingVodJobUrlOutput.html +++ b/docs/classes/SimpleEncodingVodJobUrlOutput.html @@ -1,5 +1,5 @@ SimpleEncodingVodJobUrlOutput | @bitmovin/api-sdk

Class SimpleEncodingVodJobUrlOutput

Export

SimpleEncodingVodJobUrlOutput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

artifacts? credentials? makePublic? @@ -7,14 +7,14 @@ url? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional artifacts

artifacts?: SimpleEncodingVodJobOutputArtifact[]

List of artifacts created by the encoding job. Artifacts are files essential for playback of the generated content, e.g. manifests.

+

Constructors

constructor

Properties

Optional artifacts

artifacts?: SimpleEncodingVodJobOutputArtifact[]

List of artifacts created by the encoding job. Artifacts are files essential for playback of the generated content, e.g. manifests.

Memberof

SimpleEncodingVodJobOutput

-

Optional credentials

credentials?: SimpleEncodingVodJobCredentials

Credentials to be used for authentication and accessing the folder

+

Optional credentials

credentials?: SimpleEncodingVodJobCredentials

Credentials to be used for authentication and accessing the folder

Memberof

SimpleEncodingVodJobUrlOutput

-

Optional makePublic

makePublic?: boolean

Indicates if the output should be publically available so that playback immediately works over the internet. Note that not every storage provider supports public output, in this case the flag will be ignored (e.g., Akamai NetStorage). It might forbidden by some storage configuration to make files public, for example an S3 buckets can be configured to disallow public access. In this case set it to false.

+

Optional makePublic

makePublic?: boolean

Indicates if the output should be publically available so that playback immediately works over the internet. Note that not every storage provider supports public output, in this case the flag will be ignored (e.g., Akamai NetStorage). It might forbidden by some storage configuration to make files public, for example an S3 buckets can be configured to disallow public access. In this case set it to false.

Memberof

SimpleEncodingVodJobUrlOutput

-

Readonly type

type: SimpleEncodingVodJobOutputType = SimpleEncodingVodJobOutputType.URL

Discriminator property for SimpleEncodingVodJobOutput

+

Readonly type

type: SimpleEncodingVodJobOutputType = SimpleEncodingVodJobOutputType.URL

Discriminator property for SimpleEncodingVodJobOutput

Memberof

SimpleEncodingVodJobUrlOutput

-

Optional url

url?: string

Define a URL pointing to a folder which will be used to upload the encoded assets. The output folder structure used looks the following way:

http://host/my-folder

  • /video
    • /h264/{width}x{height}_{bitrate}/ (multiple subfolders containing different output renditions)
  • /audio
    • /aac/{language}/ - if language is unique (subfolder containing audio output files)
    • /aac/{language}_{index}/ - if language is not unique (subfolder containing audio output files)
  • /subtitles (subfolder containing subtitles files)
  • /captions (subfolder containing subtitles files)
  • /sprites (subfolder containing generated sprites)
  • /thumbnails (subfolder containing generated thumbnails)
  • /index.m3u8 (HLS manifest file)
  • /stream.mpd (DASH manifest file)
Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check in the descriptions below which properties can or need to be provided within the credentials key. See below how to construct the URLs for the individual protocols/storage systems. ___ Recommendation To ensure uniqueness of output paths accross multiple encodings, make use of the following placeholders in the output's URL: {uuid} - will be replaced with a random UUID {asset} - will be replaced with the asset file name (only for the input type VIDEO or DEFAULT) Examples: * using the {uuid} placeholder: The output URL s3://<my-bucket>/{uuid}/path/ will be transformed to e.g. s3://<my-bucket>/d59295f3-1548-4bd9-843d-6ac6896dbdb6/path/. * using the {asset} placeholder: Given an input s3://my-bucket/path/filename.mp4 of type VIDEO or DEFAULT, the output URL s3://<my-bucket>/{asset}/path/ will be transformed to s3://<my-bucket>/filename/path/ Notes: - Placeholders can be combined or used multiple times in the same URL. - Placeholders are ignored when used in conjunction with DirectFileUploadInputs because in this case the asset file name cannot be set. ___ S3: * s3://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/ It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/ It is required to provide username/password credentials for authentication. (required)

+

Optional url

url?: string

Define a URL pointing to a folder which will be used to upload the encoded assets. The output folder structure used looks the following way:

http://host/my-folder

  • /video
    • /h264/{width}x{height}_{bitrate}/ (multiple subfolders containing different output renditions)
  • /audio
    • /aac/{language}/ - if language is unique (subfolder containing audio output files)
    • /aac/{language}_{index}/ - if language is not unique (subfolder containing audio output files)
  • /subtitles (subfolder containing subtitles files)
  • /captions (subfolder containing subtitles files)
  • /sprites (subfolder containing generated sprites)
  • /thumbnails (subfolder containing generated thumbnails)
  • /index.m3u8 (HLS manifest file)
  • /stream.mpd (DASH manifest file)
Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check in the descriptions below which properties can or need to be provided within the credentials key. See below how to construct the URLs for the individual protocols/storage systems. ___ Recommendation To ensure uniqueness of output paths accross multiple encodings, make use of the following placeholders in the output's URL: {uuid} - will be replaced with a random UUID {asset} - will be replaced with the asset file name (only for the input type VIDEO or DEFAULT) Examples: * using the {uuid} placeholder: The output URL s3://<my-bucket>/{uuid}/path/ will be transformed to e.g. s3://<my-bucket>/d59295f3-1548-4bd9-843d-6ac6896dbdb6/path/. * using the {asset} placeholder: Given an input s3://my-bucket/path/filename.mp4 of type VIDEO or DEFAULT, the output URL s3://<my-bucket>/{asset}/path/ will be transformed to s3://<my-bucket>/filename/path/ Notes: - Placeholders can be combined or used multiple times in the same URL. - Placeholders are ignored when used in conjunction with DirectFileUploadInputs because in this case the asset file name cannot be set. ___ S3: * s3://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/ It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/ It is required to provide username/password credentials for authentication. (required)

Memberof

SimpleEncodingVodJobUrlOutput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

  • CDN: string
  • URL: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorartifactscredentialsmakePublictypeurl_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CDN: string;
    URL: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorartifactscredentialsmakePublictypeurl_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SimpleEncodingVodJobUsernamePasswordCredentials.html b/docs/classes/SimpleEncodingVodJobUsernamePasswordCredentials.html index e78b40fdf..788d5d482 100644 --- a/docs/classes/SimpleEncodingVodJobUsernamePasswordCredentials.html +++ b/docs/classes/SimpleEncodingVodJobUsernamePasswordCredentials.html @@ -1,9 +1,9 @@ SimpleEncodingVodJobUsernamePasswordCredentials | @bitmovin/api-sdk

Class SimpleEncodingVodJobUsernamePasswordCredentials

Export

SimpleEncodingVodJobUsernamePasswordCredentials

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

password? username? -

Constructors

constructor

Properties

Optional password

password?: string

The password to be used for authentication (required)

+

Constructors

constructor

Properties

Optional password

password?: string

The password to be used for authentication (required)

Memberof

SimpleEncodingVodJobUsernamePasswordCredentials

-

Optional username

username?: string

The username to be used for authentication. (required)

+

Optional username

username?: string

The username to be used for authentication. (required)

Memberof

SimpleEncodingVodJobUsernamePasswordCredentials

-

Settings

Member Visibility

Theme

On This Page

constructorpasswordusername
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpasswordusername
\ No newline at end of file diff --git a/docs/classes/SmoothManifestContentProtection.html b/docs/classes/SmoothManifestContentProtection.html index dcfe2f6e8..fce951f84 100644 --- a/docs/classes/SmoothManifestContentProtection.html +++ b/docs/classes/SmoothManifestContentProtection.html @@ -1,5 +1,5 @@ SmoothManifestContentProtection | @bitmovin/api-sdk

Class SmoothManifestContentProtection

Export

SmoothManifestContentProtection

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -9,22 +9,22 @@ modifiedAt? muxingId? name? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional drmId

drmId?: string

Id of the drm. (required)

+

Optional drmId

drmId?: string

Id of the drm. (required)

Memberof

SmoothManifestContentProtection

-

Optional encodingId

encodingId?: string

Id of the encoding. (required)

+

Optional encodingId

encodingId?: string

Id of the encoding. (required)

Memberof

SmoothManifestContentProtection

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

SmoothManifestContentProtection

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptiondrmIdencodingIdidmodifiedAtmuxingIdname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptiondrmIdencodingIdidmodifiedAtmuxingIdname
\ No newline at end of file diff --git a/docs/classes/SmoothManifestDefault.html b/docs/classes/SmoothManifestDefault.html index 58d9c1cc8..1634f56fa 100644 --- a/docs/classes/SmoothManifestDefault.html +++ b/docs/classes/SmoothManifestDefault.html @@ -1,5 +1,5 @@ SmoothManifestDefault | @bitmovin/api-sdk

Class SmoothManifestDefault

Export

SmoothManifestDefault

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

clientManifestName? createdAt? customData? @@ -13,29 +13,29 @@ status? type? version? -

Constructors

constructor

Properties

Optional clientManifestName

clientManifestName?: string

Filename of the client manifest

+

Constructors

constructor

Properties

Optional clientManifestName

clientManifestName?: string

Filename of the client manifest

Memberof

SmoothStreamingManifest

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional encodingId

encodingId?: string

The id of the encoding to create a default manifest for (required)

+

Optional encodingId

encodingId?: string

The id of the encoding to create a default manifest for (required)

Memberof

SmoothManifestDefault

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

+

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

Memberof

Manifest

-

Optional serverManifestName

serverManifestName?: string

Filename of the server manifest

+

Optional serverManifestName

serverManifestName?: string

Filename of the server manifest

Memberof

SmoothStreamingManifest

-

Optional status

status?: Status

Current status

+

Optional status

status?: Status

Current status

Memberof

Manifest

-

Optional type

type?: ManifestType

Memberof

Manifest

-

Optional version

version?: V1

Currently not in use

+

Optional type

type?: ManifestType

Memberof

Manifest

+

Optional version

version?: V1

Currently not in use

Memberof

SmoothManifestDefault

-

Settings

Member Visibility

Theme

On This Page

constructorclientManifestNamecreatedAtcustomDatadescriptionencodingIdidmodifiedAtnameoutputsserverManifestNamestatustypeversion
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorclientManifestNamecreatedAtcustomDatadescriptionencodingIdidmodifiedAtnameoutputsserverManifestNamestatustypeversion
\ No newline at end of file diff --git a/docs/classes/SmoothStreamingManifest.html b/docs/classes/SmoothStreamingManifest.html index 199b52c33..73e4c8e0b 100644 --- a/docs/classes/SmoothStreamingManifest.html +++ b/docs/classes/SmoothStreamingManifest.html @@ -1,5 +1,5 @@ SmoothStreamingManifest | @bitmovin/api-sdk

Class SmoothStreamingManifest

Export

SmoothStreamingManifest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

clientManifestName? createdAt? customData? @@ -11,25 +11,25 @@ serverManifestName? status? type? -

Constructors

constructor

Properties

Optional clientManifestName

clientManifestName?: string

Filename of the client manifest

+

Constructors

constructor

Properties

Optional clientManifestName

clientManifestName?: string

Filename of the client manifest

Memberof

SmoothStreamingManifest

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

+

Optional outputs

outputs?: EncodingOutput[]

The outputs to store the manifest (required)

Memberof

Manifest

-

Optional serverManifestName

serverManifestName?: string

Filename of the server manifest

+

Optional serverManifestName

serverManifestName?: string

Filename of the server manifest

Memberof

SmoothStreamingManifest

-

Optional status

status?: Status

Current status

+

Optional status

status?: Status

Current status

Memberof

Manifest

-

Optional type

type?: ManifestType

Memberof

Manifest

-

Settings

Member Visibility

Theme

On This Page

constructorclientManifestNamecreatedAtcustomDatadescriptionidmodifiedAtnameoutputsserverManifestNamestatustype
\ No newline at end of file +

Optional type

type?: ManifestType

Memberof

Manifest

+

Settings

Member Visibility

Theme

On This Page

constructorclientManifestNamecreatedAtcustomDatadescriptionidmodifiedAtnameoutputsserverManifestNamestatustype
\ No newline at end of file diff --git a/docs/classes/SmoothStreamingRepresentation.html b/docs/classes/SmoothStreamingRepresentation.html index 8e830c3db..598875729 100644 --- a/docs/classes/SmoothStreamingRepresentation.html +++ b/docs/classes/SmoothStreamingRepresentation.html @@ -1,5 +1,5 @@ SmoothStreamingRepresentation | @bitmovin/api-sdk

Class SmoothStreamingRepresentation

Export

SmoothStreamingRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,28 +12,28 @@ name? priority? trackName? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional encodingId

encodingId?: string

Id of the encoding (required)

+

Optional encodingId

encodingId?: string

Id of the encoding (required)

Memberof

SmoothStreamingRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional language

language?: string

Language of the MP4 file

+

Optional language

language?: string

Language of the MP4 file

Memberof

SmoothStreamingRepresentation

-

Optional mediaFile

mediaFile?: string

The Smooth Streaming ismv or isma file that will be referenced in the manifest. (required)

+

Optional mediaFile

mediaFile?: string

The Smooth Streaming ismv or isma file that will be referenced in the manifest. (required)

Memberof

SmoothStreamingRepresentation

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

SmoothStreamingRepresentation

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional priority

priority?: number

Specifies the priority of this representation. In the manifest, representations will appear ordered by descending priority values.

+

Optional priority

priority?: number

Specifies the priority of this representation. In the manifest, representations will appear ordered by descending priority values.

Memberof

SmoothStreamingRepresentation

-

Optional trackName

trackName?: string

Track where this MP4 shoudl be added

+

Optional trackName

trackName?: string

Track where this MP4 shoudl be added

Memberof

SmoothStreamingRepresentation

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionencodingIdidlanguagemediaFilemodifiedAtmuxingIdnameprioritytrackName
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionencodingIdidlanguagemediaFilemodifiedAtmuxingIdnameprioritytrackName
\ No newline at end of file diff --git a/docs/classes/SourceChannel.html b/docs/classes/SourceChannel.html index 4118eff1f..1059ba073 100644 --- a/docs/classes/SourceChannel.html +++ b/docs/classes/SourceChannel.html @@ -1,11 +1,11 @@ SourceChannel | @bitmovin/api-sdk

Class SourceChannel

Export

SourceChannel

-

Constructors

constructor +

Constructors

constructor

Properties

channelNumber? gain? type? -

Constructors

constructor

Properties

Optional channelNumber

channelNumber?: number

Number of this source channel. If type is 'CHANNEL_NUMBER', this must be set.

+

Constructors

constructor

Properties

Optional channelNumber

channelNumber?: number

Number of this source channel. If type is 'CHANNEL_NUMBER', this must be set.

Memberof

SourceChannel

-

Optional gain

gain?: number

Gain for this source channel. Default is 1.0.

+

Optional gain

gain?: number

Gain for this source channel. Default is 1.0.

Memberof

SourceChannel

-

Optional type

type?: SourceChannelType

Memberof

SourceChannel

-

Settings

Member Visibility

Theme

On This Page

constructorchannelNumbergaintype
\ No newline at end of file +

Optional type

type?: SourceChannelType

Memberof

SourceChannel

+

Settings

Member Visibility

Theme

On This Page

constructorchannelNumbergaintype
\ No newline at end of file diff --git a/docs/classes/SpekeDrm.html b/docs/classes/SpekeDrm.html index 172e438ff..0fd2fdf71 100644 --- a/docs/classes/SpekeDrm.html +++ b/docs/classes/SpekeDrm.html @@ -1,5 +1,5 @@ SpekeDrm | @bitmovin/api-sdk

Class SpekeDrm

Export

SpekeDrm

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

contentId? createdAt? customData? @@ -15,29 +15,29 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional contentId

contentId?: string

Unique Identifier of the content, will be generated if not set

+

Constructors

constructor

Properties

Optional contentId

contentId?: string

Unique Identifier of the content, will be generated if not set

Memberof

SpekeDrm

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional iv

iv?: string

16 byte initialization vector represented by a 32-character text string. It is mandatory if systemIds contains AES128 or FairPlay.

+

Optional iv

iv?: string

16 byte initialization vector represented by a 32-character text string. It is mandatory if systemIds contains AES128 or FairPlay.

Memberof

SpekeDrm

-

Optional kid

kid?: string

Optional key identifier, will be generated if not set. For SPEKE DRM Configurations with the same contentId and kid the key provider will provide the same keys.

+

Optional kid

kid?: string

Optional key identifier, will be generated if not set. For SPEKE DRM Configurations with the same contentId and kid the key provider will provide the same keys.

Memberof

SpekeDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Optional provider

provider?: SpekeDrmProvider

Key provider configuration for SPEKE (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Optional provider

provider?: SpekeDrmProvider

Key provider configuration for SPEKE (required)

Memberof

SpekeDrm

-

Optional systemIds

systemIds?: string[]

DRM system identifier of the content protection scheme. At minimum one is expected. Not all systemIds are currently supported, support depends on the muxing type. Relates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/ (required)

+

Optional systemIds

systemIds?: string[]

DRM system identifier of the content protection scheme. At minimum one is expected. Not all systemIds are currently supported, support depends on the muxing type. Relates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/ (required)

Memberof

SpekeDrm

-

Readonly type

type: DrmType = DrmType.SPEKE

Discriminator property for Drm

+

Readonly type

type: DrmType = DrmType.SPEKE

Discriminator property for Drm

Memberof

SpekeDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcontentIdcreatedAtcustomDatadescriptionidivkidmodifiedAtnameoutputsprovidersystemIdstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcontentIdcreatedAtcustomDatadescriptionidivkidmodifiedAtnameoutputsprovidersystemIdstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SpekeDrmProvider.html b/docs/classes/SpekeDrmProvider.html index 74b04bf80..3fc1e9065 100644 --- a/docs/classes/SpekeDrmProvider.html +++ b/docs/classes/SpekeDrmProvider.html @@ -1,5 +1,5 @@ SpekeDrmProvider | @bitmovin/api-sdk

Class SpekeDrmProvider

Export

SpekeDrmProvider

-

Constructors

constructor +

Constructors

constructor

Properties

apiKey? externalId? externalIdMode? @@ -8,19 +8,19 @@ roleArn? url? username? -

Constructors

constructor

Properties

Optional apiKey

apiKey?: string

Your API key for authentication via X-API-Key HTTP Header

+

Constructors

constructor

Properties

Optional apiKey

apiKey?: string

Your API key for authentication via X-API-Key HTTP Header

Memberof

SpekeDrmProvider

-

Optional externalId

externalId?: string

External ID used together with the IAM role identified by roleArn to assume access to the SPEKE server on AWS.

+

Optional externalId

externalId?: string

External ID used together with the IAM role identified by roleArn to assume access to the SPEKE server on AWS.

Memberof

SpekeDrmProvider

-

Optional externalIdMode

externalIdMode?: ExternalIdMode

Memberof

SpekeDrmProvider

-

Optional gatewayRegion

gatewayRegion?: string

Describes the region of the AWS API Gateway that is used to access the SPEKE server. This property is mandatory when setting 'roleArn' and has to indicate in which region the AWS API Gateway is setup. This usually corresponds to the {{region}} one sets in the execute-api policy for the role as described in 'roleArn'.

+

Optional externalIdMode

externalIdMode?: ExternalIdMode

Memberof

SpekeDrmProvider

+

Optional gatewayRegion

gatewayRegion?: string

Describes the region of the AWS API Gateway that is used to access the SPEKE server. This property is mandatory when setting 'roleArn' and has to indicate in which region the AWS API Gateway is setup. This usually corresponds to the {{region}} one sets in the execute-api policy for the role as described in 'roleArn'.

Memberof

SpekeDrmProvider

-

Optional password

password?: string

Your password for Basic Authentication

+

Optional password

password?: string

Your password for Basic Authentication

Memberof

SpekeDrmProvider

-

Optional roleArn

roleArn?: string

AWS role that will be assumed for the key exchange in case the provider runs on AWS. During the key exchange the role will be assumed to be able to access the key provider. This role is to be created in the customer's account and must be granted access to the API Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } It is recommended to also set the {{externalId}} due to security reasons but it can also be ommitted. Additionally the role needs a policy similar to the following to be able to invoke the API gateway: { \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": [ \"execute-api:Invoke\" ], \"Resource\": [ \"arn:aws:execute-api:{{region}}:*:*_/_*_/POST/_*\" ] } ] } where {{region}} is the region of the API gateway (for example us-west-2), the same has to be set in the property 'gatewayRegion'. It's also possible to set {{region} to * to give the role access to all regions.

+

Optional roleArn

roleArn?: string

AWS role that will be assumed for the key exchange in case the provider runs on AWS. During the key exchange the role will be assumed to be able to access the key provider. This role is to be created in the customer's account and must be granted access to the API Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } It is recommended to also set the {{externalId}} due to security reasons but it can also be ommitted. Additionally the role needs a policy similar to the following to be able to invoke the API gateway: { \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": [ \"execute-api:Invoke\" ], \"Resource\": [ \"arn:aws:execute-api:{{region}}:*:*_/_*_/POST/_*\" ] } ] } where {{region}} is the region of the API gateway (for example us-west-2), the same has to be set in the property 'gatewayRegion'. It's also possible to set {{region} to * to give the role access to all regions.

Memberof

SpekeDrmProvider

-

Optional url

url?: string

URL of the endpoint (required)

+

Optional url

url?: string

URL of the endpoint (required)

Memberof

SpekeDrmProvider

-

Optional username

username?: string

Your username for Basic Authentication

+

Optional username

username?: string

Your username for Basic Authentication

Memberof

SpekeDrmProvider

-

Settings

Member Visibility

Theme

On This Page

constructorapiKeyexternalIdexternalIdModegatewayRegionpasswordroleArnurlusername
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiKeyexternalIdexternalIdModegatewayRegionpasswordroleArnurlusername
\ No newline at end of file diff --git a/docs/classes/Sprite.html b/docs/classes/Sprite.html index 08da91ccb..344559ae7 100644 --- a/docs/classes/Sprite.html +++ b/docs/classes/Sprite.html @@ -1,5 +1,5 @@ Sprite | @bitmovin/api-sdk

Class Sprite

Export

Sprite

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

aspectMode? createdAt? creationMode? @@ -20,42 +20,42 @@ vTiles? vttName? width? -

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: ThumbnailAspectMode

Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.

+

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: ThumbnailAspectMode

Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.

Memberof

Sprite

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional creationMode

creationMode?: SpriteCreationMode

The creation mode for the thumbnails in the Sprite. Two possible creation modes exist: generate thumbnails starting with the beginning of the video or after the first configured period. When using distance=10 and unit=SECONDS and INTERVAL_END, the first image of the sprite is from the second 10 of the video. When using distance=10 and unit=SECONDS and INTERVAL_START, the first image of the sprite is from the very start of the video, while the second image is from second 10 of the video. It is recommended to use 'INTERVAL_START' when using the sprites for trick play so that there is an additional thumbnail from the beginning of the video. Only supported starting with encoder version 2.76.0.

+

Optional creationMode

creationMode?: SpriteCreationMode

The creation mode for the thumbnails in the Sprite. Two possible creation modes exist: generate thumbnails starting with the beginning of the video or after the first configured period. When using distance=10 and unit=SECONDS and INTERVAL_END, the first image of the sprite is from the second 10 of the video. When using distance=10 and unit=SECONDS and INTERVAL_START, the first image of the sprite is from the very start of the video, while the second image is from second 10 of the video. It is recommended to use 'INTERVAL_START' when using the sprites for trick play so that there is an additional thumbnail from the beginning of the video. Only supported starting with encoder version 2.76.0.

Memberof

Sprite

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional distance

distance?: number

Distance in the given unit between a screenshot

+

Optional distance

distance?: number

Distance in the given unit between a screenshot

Memberof

Sprite

-

Optional filename

filename?: string

Filename of the sprite image. If not set, spriteName will be used, but without an extension.

+

Optional filename

filename?: string

Filename of the sprite image. If not set, spriteName will be used, but without an extension.

Memberof

Sprite

-

Optional hTiles

hTiles?: number

Number of rows of images per file. Has to be set together with vTiles. If this property and vTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version 2.76.0.

+

Optional hTiles

hTiles?: number

Number of rows of images per file. Has to be set together with vTiles. If this property and vTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version 2.76.0.

Memberof

Sprite

-

Optional height

height?: number

Height of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required

+

Optional height

height?: number

Height of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required

Memberof

Sprite

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional imagesPerFile

imagesPerFile?: number

Number of images per file. If more images are generated than specified in this value, multiple sprites will be created. You can use the placeholder '%number%' in the spriteName to specify the naming policy. Either this property must be set or hTiles and vTiles.

+

Optional imagesPerFile

imagesPerFile?: number

Number of images per file. If more images are generated than specified in this value, multiple sprites will be created. You can use the placeholder '%number%' in the spriteName to specify the naming policy. Either this property must be set or hTiles and vTiles.

Memberof

Sprite

-

Optional jpegConfig

jpegConfig?: SpriteJpegConfig

Additional configuration for JPEG sprite generation. If this property is set the extension of the file must be '.jpg.' or '.jpeg' Only supported starting with encoder version 2.76.0

+

Optional jpegConfig

jpegConfig?: SpriteJpegConfig

Additional configuration for JPEG sprite generation. If this property is set the extension of the file must be '.jpg.' or '.jpeg' Only supported starting with encoder version 2.76.0

Memberof

Sprite

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Sprite

-

Optional spriteName

spriteName?: string

Name of the sprite image. File extension ".jpg"/".jpeg" or ".png" is required. (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Sprite

+

Optional spriteName

spriteName?: string

Name of the sprite image. File extension ".jpg"/".jpeg" or ".png" is required. (required)

Memberof

Sprite

-

Optional unit

unit?: SpriteUnit

Memberof

Sprite

-

Optional vTiles

vTiles?: number

Number of columns of images per file. Has to be set together with hTiles. If this property and hTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version 2.76.0.

+

Optional unit

unit?: SpriteUnit

Memberof

Sprite

+

Optional vTiles

vTiles?: number

Number of columns of images per file. Has to be set together with hTiles. If this property and hTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version 2.76.0.

Memberof

Sprite

-

Optional vttName

vttName?: string

Filename of the vtt-file. The file-extension ".vtt" is required.

+

Optional vttName

vttName?: string

Filename of the vtt-file. The file-extension ".vtt" is required.

Memberof

Sprite

-

Optional width

width?: number

Width of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required

+

Optional width

width?: number

Width of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required

Memberof

Sprite

-

Settings

Member Visibility

Theme

On This Page

constructoraspectModecreatedAtcreationModecustomDatadescriptiondistancefilenamehTilesheightidimagesPerFilejpegConfigmodifiedAtnameoutputsspriteNameunitvTilesvttNamewidth
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraspectModecreatedAtcreationModecustomDatadescriptiondistancefilenamehTilesheightidimagesPerFilejpegConfigmodifiedAtnameoutputsspriteNameunitvTilesvttNamewidth
\ No newline at end of file diff --git a/docs/classes/SpriteJpegConfig.html b/docs/classes/SpriteJpegConfig.html index c0e496dfa..8549ceb43 100644 --- a/docs/classes/SpriteJpegConfig.html +++ b/docs/classes/SpriteJpegConfig.html @@ -1,6 +1,6 @@ SpriteJpegConfig | @bitmovin/api-sdk

Class SpriteJpegConfig

Export

SpriteJpegConfig

-

Constructors

constructor +

Constructors

constructor

Properties

quality? -

Constructors

constructor

Properties

Optional quality

quality?: number

Quality of the JPEG file in percent. Allowed values 20 - 100 (required)

+

Constructors

constructor

Properties

Optional quality

quality?: number

Quality of the JPEG file in percent. Allowed values 20 - 100 (required)

Memberof

SpriteJpegConfig

-

Settings

Member Visibility

Theme

On This Page

constructorquality
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorquality
\ No newline at end of file diff --git a/docs/classes/SpriteRepresentation.html b/docs/classes/SpriteRepresentation.html index af877e7fa..e50b92ac9 100644 --- a/docs/classes/SpriteRepresentation.html +++ b/docs/classes/SpriteRepresentation.html @@ -1,5 +1,5 @@ SpriteRepresentation | @bitmovin/api-sdk

Class SpriteRepresentation

Export

SpriteRepresentation

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

encodingId? id? segmentPath? @@ -8,16 +8,16 @@ typeDiscriminator _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional encodingId

encodingId?: string

UUID of an encoding (required)

+

Constructors

constructor

Properties

Optional encodingId

encodingId?: string

UUID of an encoding (required)

Memberof

SpriteRepresentation

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional segmentPath

segmentPath?: string

Path to sprite segments. Will be used as the representation id in the manifest. (required)

+

Optional segmentPath

segmentPath?: string

Path to sprite segments. Will be used as the representation id in the manifest. (required)

Memberof

SpriteRepresentation

-

Optional spriteId

spriteId?: string

UUID of a Sprite (required)

+

Optional spriteId

spriteId?: string

UUID of a Sprite (required)

Memberof

SpriteRepresentation

-

Optional streamId

streamId?: string

UUID of a stream (required)

+

Optional streamId

streamId?: string

UUID of a stream (required)

Memberof

SpriteRepresentation

-

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.SPRITE

Discriminator property for DashRepresentation

+

Readonly typeDiscriminator

typeDiscriminator: DashRepresentationTypeDiscriminator = DashRepresentationTypeDiscriminator.SPRITE

Discriminator property for DashRepresentation

Memberof

SpriteRepresentation

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

  • CHUNKED_TEXT: string
  • CMAF: string
  • CONTENT_PROTECTION: string
  • DRM_FMP4: string
  • DRM_MP4: string
  • FMP4: string
  • IMSC: string
  • MP4: string
  • PROGRESSIVE_WEBM: string
  • SPRITE: string
  • VTT: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructorencodingIdidsegmentPathspriteIdstreamIdtypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    CHUNKED_TEXT: string;
    CMAF: string;
    CONTENT_PROTECTION: string;
    DRM_FMP4: string;
    DRM_MP4: string;
    FMP4: string;
    IMSC: string;
    MP4: string;
    PROGRESSIVE_WEBM: string;
    SPRITE: string;
    VTT: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "typeDiscriminator" = 'typeDiscriminator'

Settings

Member Visibility

Theme

On This Page

constructorencodingIdidsegmentPathspriteIdstreamIdtypeDiscriminator_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SrtInput.html b/docs/classes/SrtInput.html index 1aca02123..6b13d574e 100644 --- a/docs/classes/SrtInput.html +++ b/docs/classes/SrtInput.html @@ -1,5 +1,5 @@ SrtInput | @bitmovin/api-sdk

Class SrtInput

Export

SrtInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

backupSrtInputs? createdAt? customData? @@ -17,33 +17,33 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional backupSrtInputs

backupSrtInputs?: BackupSrtInputs

Memberof

SrtInput

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional backupSrtInputs

backupSrtInputs?: BackupSrtInputs

Memberof

SrtInput

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

The name or IP of the host providing the SRT stream (only used in CALLER mode)

+

Optional host

host?: string

The name or IP of the host providing the SRT stream (only used in CALLER mode)

Memberof

SrtInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional keyLength

keyLength?: number

The type of AES encryption determines the length of the key (passphrase). AES-128 uses a 16-character (128-bit) passphrase, and AES-256 uses a 32-character (256-bit) passphrase.

+

Optional keyLength

keyLength?: number

The type of AES encryption determines the length of the key (passphrase). AES-128 uses a 16-character (128-bit) passphrase, and AES-256 uses a 32-character (256-bit) passphrase.

Memberof

SrtInput

-

Optional latency

latency?: number

The maximum accepted transmission latency in milliseconds (when both parties set different values, the maximum of the two is used for both)

+

Optional latency

latency?: number

The maximum accepted transmission latency in milliseconds (when both parties set different values, the maximum of the two is used for both)

Memberof

SrtInput

-

Optional mode

mode?: SrtMode

The SRT mode to use (required)

+

Optional mode

mode?: SrtMode

The SRT mode to use (required)

Memberof

SrtInput

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional passphrase

passphrase?: string

The passphrase used to secure the SRT stream. For AES-128 encryption, you must enter a 16-character passphrase; for AES-256, you must enter a 32-character passphrase

+

Optional passphrase

passphrase?: string

The passphrase used to secure the SRT stream. For AES-128 encryption, you must enter a 16-character passphrase; for AES-256, you must enter a 32-character passphrase

Memberof

SrtInput

-

Optional path

path?: string

The path parameter of the SRT stream

+

Optional path

path?: string

The path parameter of the SRT stream

Memberof

SrtInput

-

Optional port

port?: number

The port to connect to or listen on. Has to be one of [2088, 2089, 2090, 2091] when using LISTENER mode. (required)

+

Optional port

port?: number

The port to connect to or listen on. Has to be one of [2088, 2089, 2090, 2091] when using LISTENER mode. (required)

Memberof

SrtInput

-

Readonly type

type: InputType = InputType.SRT

Discriminator property for Input

+

Readonly type

type: InputType = InputType.SRT

Discriminator property for Input

Memberof

SrtInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbackupSrtInputscreatedAtcustomDatadescriptionhostidkeyLengthlatencymodemodifiedAtnamepassphrasepathporttype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbackupSrtInputscreatedAtcustomDatadescriptionhostidkeyLengthlatencymodemodifiedAtnamepassphrasepathporttype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SrtStatisticLink.html b/docs/classes/SrtStatisticLink.html index 57fe13bcb..26ecb775a 100644 --- a/docs/classes/SrtStatisticLink.html +++ b/docs/classes/SrtStatisticLink.html @@ -1,9 +1,9 @@ SrtStatisticLink | @bitmovin/api-sdk

Class SrtStatisticLink

Export

SrtStatisticLink

-

Constructors

constructor +

Constructors

constructor

Properties

bandwidth? maxBandwidth? rtt? -

Constructors

constructor

Properties

Optional bandwidth

bandwidth?: number

Memberof

SrtStatisticLink

-

Optional maxBandwidth

maxBandwidth?: number

Memberof

SrtStatisticLink

-

Optional rtt

rtt?: number

Memberof

SrtStatisticLink

-

Settings

Member Visibility

Theme

On This Page

constructorbandwidthmaxBandwidthrtt
\ No newline at end of file +

Constructors

constructor

Properties

Optional bandwidth

bandwidth?: number

Memberof

SrtStatisticLink

+

Optional maxBandwidth

maxBandwidth?: number

Memberof

SrtStatisticLink

+

Optional rtt

rtt?: number

Memberof

SrtStatisticLink

+

Settings

Member Visibility

Theme

On This Page

constructorbandwidthmaxBandwidthrtt
\ No newline at end of file diff --git a/docs/classes/SrtStatisticRecv.html b/docs/classes/SrtStatisticRecv.html index 10c9eea85..b36d1232a 100644 --- a/docs/classes/SrtStatisticRecv.html +++ b/docs/classes/SrtStatisticRecv.html @@ -1,5 +1,5 @@ SrtStatisticRecv | @bitmovin/api-sdk

Class SrtStatisticRecv

Export

SrtStatisticRecv

-

Constructors

constructor +

Constructors

constructor

Properties

bytes? bytesDropped? bytesLost? @@ -9,13 +9,13 @@ packetsDropped? packetsLost? packetsRetransmitted? -

Constructors

constructor

Properties

Optional bytes

bytes?: number

Memberof

SrtStatisticRecv

-

Optional bytesDropped

bytesDropped?: number

Memberof

SrtStatisticRecv

-

Optional bytesLost

bytesLost?: number

Memberof

SrtStatisticRecv

-

Optional mbitRate

mbitRate?: number

Memberof

SrtStatisticRecv

-

Optional packets

packets?: number

Memberof

SrtStatisticRecv

-

Optional packetsBelated

packetsBelated?: number

Memberof

SrtStatisticRecv

-

Optional packetsDropped

packetsDropped?: number

Memberof

SrtStatisticRecv

-

Optional packetsLost

packetsLost?: number

Memberof

SrtStatisticRecv

-

Optional packetsRetransmitted

packetsRetransmitted?: number

Memberof

SrtStatisticRecv

-

Settings

Member Visibility

Theme

On This Page

constructorbytesbytesDroppedbytesLostmbitRatepacketspacketsBelatedpacketsDroppedpacketsLostpacketsRetransmitted
\ No newline at end of file +

Constructors

constructor

Properties

Optional bytes

bytes?: number

Memberof

SrtStatisticRecv

+

Optional bytesDropped

bytesDropped?: number

Memberof

SrtStatisticRecv

+

Optional bytesLost

bytesLost?: number

Memberof

SrtStatisticRecv

+

Optional mbitRate

mbitRate?: number

Memberof

SrtStatisticRecv

+

Optional packets

packets?: number

Memberof

SrtStatisticRecv

+

Optional packetsBelated

packetsBelated?: number

Memberof

SrtStatisticRecv

+

Optional packetsDropped

packetsDropped?: number

Memberof

SrtStatisticRecv

+

Optional packetsLost

packetsLost?: number

Memberof

SrtStatisticRecv

+

Optional packetsRetransmitted

packetsRetransmitted?: number

Memberof

SrtStatisticRecv

+

Settings

Member Visibility

Theme

On This Page

constructorbytesbytesDroppedbytesLostmbitRatepacketspacketsBelatedpacketsDroppedpacketsLostpacketsRetransmitted
\ No newline at end of file diff --git a/docs/classes/SrtStatisticSend.html b/docs/classes/SrtStatisticSend.html index 6d9b70d2d..9e21edfdb 100644 --- a/docs/classes/SrtStatisticSend.html +++ b/docs/classes/SrtStatisticSend.html @@ -1,5 +1,5 @@ SrtStatisticSend | @bitmovin/api-sdk

Class SrtStatisticSend

Export

SrtStatisticSend

-

Constructors

constructor +

Constructors

constructor

Properties

bytes? bytesDropped? mbitRate? @@ -7,11 +7,11 @@ packetsDropped? packetsLost? packetsRetransmitted? -

Constructors

constructor

Properties

Optional bytes

bytes?: number

Memberof

SrtStatisticSend

-

Optional bytesDropped

bytesDropped?: number

Memberof

SrtStatisticSend

-

Optional mbitRate

mbitRate?: number

Memberof

SrtStatisticSend

-

Optional packets

packets?: number

Memberof

SrtStatisticSend

-

Optional packetsDropped

packetsDropped?: number

Memberof

SrtStatisticSend

-

Optional packetsLost

packetsLost?: number

Memberof

SrtStatisticSend

-

Optional packetsRetransmitted

packetsRetransmitted?: number

Memberof

SrtStatisticSend

-

Settings

Member Visibility

Theme

On This Page

constructorbytesbytesDroppedmbitRatepacketspacketsDroppedpacketsLostpacketsRetransmitted
\ No newline at end of file +

Constructors

constructor

Properties

Optional bytes

bytes?: number

Memberof

SrtStatisticSend

+

Optional bytesDropped

bytesDropped?: number

Memberof

SrtStatisticSend

+

Optional mbitRate

mbitRate?: number

Memberof

SrtStatisticSend

+

Optional packets

packets?: number

Memberof

SrtStatisticSend

+

Optional packetsDropped

packetsDropped?: number

Memberof

SrtStatisticSend

+

Optional packetsLost

packetsLost?: number

Memberof

SrtStatisticSend

+

Optional packetsRetransmitted

packetsRetransmitted?: number

Memberof

SrtStatisticSend

+

Settings

Member Visibility

Theme

On This Page

constructorbytesbytesDroppedmbitRatepacketspacketsDroppedpacketsLostpacketsRetransmitted
\ No newline at end of file diff --git a/docs/classes/SrtStatisticWindow.html b/docs/classes/SrtStatisticWindow.html index 56ab9f865..df2ff9ca7 100644 --- a/docs/classes/SrtStatisticWindow.html +++ b/docs/classes/SrtStatisticWindow.html @@ -1,9 +1,9 @@ SrtStatisticWindow | @bitmovin/api-sdk

Class SrtStatisticWindow

Export

SrtStatisticWindow

-

Constructors

constructor +

Constructors

constructor

Properties

congestion? flight? flow? -

Constructors

constructor

Properties

Optional congestion

congestion?: number

Memberof

SrtStatisticWindow

-

Optional flight

flight?: number

Memberof

SrtStatisticWindow

-

Optional flow

flow?: number

Memberof

SrtStatisticWindow

-

Settings

Member Visibility

Theme

On This Page

constructorcongestionflightflow
\ No newline at end of file +

Constructors

constructor

Properties

Optional congestion

congestion?: number

Memberof

SrtStatisticWindow

+

Optional flight

flight?: number

Memberof

SrtStatisticWindow

+

Optional flow

flow?: number

Memberof

SrtStatisticWindow

+

Settings

Member Visibility

Theme

On This Page

constructorcongestionflightflow
\ No newline at end of file diff --git a/docs/classes/SrtStatistics.html b/docs/classes/SrtStatistics.html index 200fa1aa3..bfcd8b800 100644 --- a/docs/classes/SrtStatistics.html +++ b/docs/classes/SrtStatistics.html @@ -1,5 +1,5 @@ SrtStatistics | @bitmovin/api-sdk

Class SrtStatistics

Export

SrtStatistics

-

Constructors

constructor +

Constructors

constructor

Properties

createdAt? encodingId? id? @@ -11,22 +11,22 @@ srtInputSelected? userId? window? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Timestamp when the srt statistics event was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Timestamp when the srt statistics event was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

SrtStatistics

-

Optional encodingId

encodingId?: string

UUID of an encoding

+

Optional encodingId

encodingId?: string

UUID of an encoding

Memberof

SrtStatistics

-

Optional id

id?: string

UUID of the statistic event

+

Optional id

id?: string

UUID of the statistic event

Memberof

SrtStatistics

-

Optional link

link?: SrtStatisticLink

Memberof

SrtStatistics

-

Optional orgId

orgId?: string

UUID of the associated organization

+

Optional link

link?: SrtStatisticLink

Memberof

SrtStatistics

+

Optional orgId

orgId?: string

UUID of the associated organization

Memberof

SrtStatistics

-

Optional recv

recv?: SrtStatisticRecv

Memberof

SrtStatistics

-

Optional send

send?: SrtStatisticSend

Memberof

SrtStatistics

-

Optional srtInputId

srtInputId?: string

UUID of the SRT input used to capture this statistics

+

Optional recv

recv?: SrtStatisticRecv

Memberof

SrtStatistics

+

Optional send

send?: SrtStatisticSend

Memberof

SrtStatistics

+

Optional srtInputId

srtInputId?: string

UUID of the SRT input used to capture this statistics

Memberof

SrtStatistics

-

Optional srtInputSelected

srtInputSelected?: boolean

Whether the SRT input that generated this statistics was selected (i.e. actively used) at the time or not

+

Optional srtInputSelected

srtInputSelected?: boolean

Whether the SRT input that generated this statistics was selected (i.e. actively used) at the time or not

Memberof

SrtStatistics

-

Optional userId

userId?: string

UUID of the associated api-user

+

Optional userId

userId?: string

UUID of the associated api-user

Memberof

SrtStatistics

-

Optional window

window?: SrtStatisticWindow

Memberof

SrtStatistics

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtencodingIdidlinkorgIdrecvsendsrtInputIdsrtInputSelecteduserIdwindow
\ No newline at end of file +

Optional window

window?: SrtStatisticWindow

Memberof

SrtStatistics

+

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtencodingIdidlinkorgIdrecvsendsrtInputIdsrtInputSelecteduserIdwindow
\ No newline at end of file diff --git a/docs/classes/StandardMediaInfo.html b/docs/classes/StandardMediaInfo.html index 6bf3a1e45..cc8f6675c 100644 --- a/docs/classes/StandardMediaInfo.html +++ b/docs/classes/StandardMediaInfo.html @@ -1,5 +1,5 @@ StandardMediaInfo | @bitmovin/api-sdk

Class StandardMediaInfo

Export

StandardMediaInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assocLanguage? autoselect? characteristics? @@ -16,36 +16,36 @@ startSegmentNumber? streamId? uri? -

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

+

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

Memberof

BasicMediaInfo

-

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

+

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

Memberof

BasicMediaInfo

-

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

+

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

Memberof

BasicMediaInfo

-

Optional drmId

drmId?: string

Id of the DRM.

+

Optional drmId

drmId?: string

Id of the DRM.

Memberof

SegmentsMediaInfo

-

Optional encodingId

encodingId?: string

Id of the encoding. (required)

+

Optional encodingId

encodingId?: string

Id of the encoding. (required)

Memberof

SegmentsMediaInfo

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

Memberof

SegmentsMediaInfo

-

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

+

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

Memberof

BasicMediaInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

+

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

Memberof

BasicMediaInfo

-

Optional language

language?: string

Primary language in the rendition.

+

Optional language

language?: string

Primary language in the rendition.

Memberof

BasicMediaInfo

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

SegmentsMediaInfo

-

Optional name

name?: string

Human readable description of the rendition. (required)

+

Optional name

name?: string

Human readable description of the rendition. (required)

Memberof

BasicMediaInfo

-

Optional segmentPath

segmentPath?: string

Path to segments. (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. (required)

Memberof

SegmentsMediaInfo

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

Memberof

SegmentsMediaInfo

-

Optional streamId

streamId?: string

Id of the stream. (required)

+

Optional streamId

streamId?: string

Id of the stream. (required)

Memberof

SegmentsMediaInfo

-

Optional uri

uri?: string

The URI of the Rendition (required)

+

Optional uri

uri?: string

The URI of the Rendition (required)

Memberof

StandardMediaInfo

-

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumbergroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamIduri
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumbergroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamIduri
\ No newline at end of file diff --git a/docs/classes/StartEncodingRequest.html b/docs/classes/StartEncodingRequest.html index cfdcede2f..2a58b2651 100644 --- a/docs/classes/StartEncodingRequest.html +++ b/docs/classes/StartEncodingRequest.html @@ -1,5 +1,5 @@ StartEncodingRequest | @bitmovin/api-sdk

Class StartEncodingRequest

Export

StartEncodingRequest

-

Constructors

constructor +

Constructors

constructor

Properties

encodingMode? handleVariableInputFps? manifestGenerator? @@ -12,28 +12,28 @@ vodDashManifests? vodHlsManifests? vodSmoothManifests? -

Constructors

constructor

Properties

Optional encodingMode

encodingMode?: EncodingMode

The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.

+

Constructors

constructor

Properties

Optional encodingMode

encodingMode?: EncodingMode

The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.

Memberof

StartEncodingRequest

-

Optional handleVariableInputFps

handleVariableInputFps?: boolean

Enable frame dropping/duplication to handle variable frames per seconds of video input streams

+

Optional handleVariableInputFps

handleVariableInputFps?: boolean

Enable frame dropping/duplication to handle variable frames per seconds of video input streams

Memberof

StartEncodingRequest

-

Optional manifestGenerator

manifestGenerator?: ManifestGenerator

Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

+

Optional manifestGenerator

manifestGenerator?: ManifestGenerator

Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

Memberof

StartEncodingRequest

-

Optional perTitle

perTitle?: PerTitle

Per-Title settings

+

Optional perTitle

perTitle?: PerTitle

Per-Title settings

Memberof

StartEncodingRequest

-

Optional previewDashManifests

previewDashManifests?: ManifestResource[]

DASH manifests to be generated for previewing while the encoding is still running. See documentation

+

Optional previewDashManifests

previewDashManifests?: ManifestResource[]

DASH manifests to be generated for previewing while the encoding is still running. See documentation

Memberof

StartEncodingRequest

-

Optional previewHlsManifests

previewHlsManifests?: ManifestResource[]

HLS manifests to be generated for previewing while the encoding is still running. See documentation

+

Optional previewHlsManifests

previewHlsManifests?: ManifestResource[]

HLS manifests to be generated for previewing while the encoding is still running. See documentation

Memberof

StartEncodingRequest

-

Optional scheduling

scheduling?: Scheduling

Scheduling parameters of the encoding.

+

Optional scheduling

scheduling?: Scheduling

Scheduling parameters of the encoding.

Memberof

StartEncodingRequest

-

Optional trimming

trimming?: Trimming

Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.

+

Optional trimming

trimming?: Trimming

Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.

Memberof

StartEncodingRequest

-

Optional tweaks

tweaks?: Tweaks

Special tweaks for your encoding job.

+

Optional tweaks

tweaks?: Tweaks

Special tweaks for your encoding job.

Memberof

StartEncodingRequest

-

Optional vodDashManifests

vodDashManifests?: ManifestResource[]

DASH manifests to be generated right after encoding (just-in-time). See documentation

+

Optional vodDashManifests

vodDashManifests?: ManifestResource[]

DASH manifests to be generated right after encoding (just-in-time). See documentation

Memberof

StartEncodingRequest

-

Optional vodHlsManifests

vodHlsManifests?: ManifestResource[]

HLS manifests to be generated right after encoding (just-in-time). See documentation

+

Optional vodHlsManifests

vodHlsManifests?: ManifestResource[]

HLS manifests to be generated right after encoding (just-in-time). See documentation

Memberof

StartEncodingRequest

-

Optional vodSmoothManifests

vodSmoothManifests?: ManifestResource[]

Smooth Streaming manifests to be generated right after encoding (just-in-time). See documentation

+

Optional vodSmoothManifests

vodSmoothManifests?: ManifestResource[]

Smooth Streaming manifests to be generated right after encoding (just-in-time). See documentation

Memberof

StartEncodingRequest

-

Settings

Member Visibility

Theme

On This Page

constructorencodingModehandleVariableInputFpsmanifestGeneratorperTitlepreviewDashManifestspreviewHlsManifestsschedulingtrimmingtweaksvodDashManifestsvodHlsManifestsvodSmoothManifests
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorencodingModehandleVariableInputFpsmanifestGeneratorperTitlepreviewDashManifestspreviewHlsManifestsschedulingtrimmingtweaksvodDashManifestsvodHlsManifestsvodSmoothManifests
\ No newline at end of file diff --git a/docs/classes/StartLiveChannelEncodingRequest.html b/docs/classes/StartLiveChannelEncodingRequest.html index 591067b57..5ace76b09 100644 --- a/docs/classes/StartLiveChannelEncodingRequest.html +++ b/docs/classes/StartLiveChannelEncodingRequest.html @@ -1,5 +1,5 @@ StartLiveChannelEncodingRequest | @bitmovin/api-sdk

Class StartLiveChannelEncodingRequest

Export

StartLiveChannelEncodingRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoRestartConfiguration? autoShutdownConfiguration? dashManifests? @@ -8,20 +8,20 @@ manifestGenerator? reuploadSettings? streamKey? -

Constructors

constructor

Properties

Optional autoRestartConfiguration

autoRestartConfiguration?: AutoRestartConfiguration

Configuration for auto restarting the live encoding

+

Constructors

constructor

Properties

Optional autoRestartConfiguration

autoRestartConfiguration?: AutoRestartConfiguration

Configuration for auto restarting the live encoding

Memberof

StartLiveEncodingRequest

-

Optional autoShutdownConfiguration

autoShutdownConfiguration?: LiveAutoShutdownConfiguration

Configuration for auto shutdown of the live encoding

+

Optional autoShutdownConfiguration

autoShutdownConfiguration?: LiveAutoShutdownConfiguration

Configuration for auto shutdown of the live encoding

Memberof

StartLiveEncodingRequest

-

Optional dashManifests

dashManifests?: LiveDashManifest[]

DASH manifests to be generated during the encoding. See documentation

+

Optional dashManifests

dashManifests?: LiveDashManifest[]

DASH manifests to be generated during the encoding. See documentation

Memberof

StartLiveEncodingRequest

-

Optional hlsManifests

hlsManifests?: LiveHlsManifest[]

HLS manifests to be generated during the encoding. See documentation

+

Optional hlsManifests

hlsManifests?: LiveHlsManifest[]

HLS manifests to be generated during the encoding. See documentation

Memberof

StartLiveEncodingRequest

-

Optional liveEncodingMode

liveEncodingMode?: EncodingMode

The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.

+

Optional liveEncodingMode

liveEncodingMode?: EncodingMode

The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.

Memberof

StartLiveEncodingRequest

-

Optional manifestGenerator

manifestGenerator?: ManifestGenerator

Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

+

Optional manifestGenerator

manifestGenerator?: ManifestGenerator

Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

Memberof

StartLiveEncodingRequest

-

Optional reuploadSettings

reuploadSettings?: ReuploadSettings

Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage

+

Optional reuploadSettings

reuploadSettings?: ReuploadSettings

Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage

Memberof

StartLiveEncodingRequest

-

Optional streamKey

streamKey?: string

Key for the stream. (a-zA-Z, 3-20 characters) (required)

+

Optional streamKey

streamKey?: string

Key for the stream. (a-zA-Z, 3-20 characters) (required)

Memberof

StartLiveEncodingRequest

-

Settings

Member Visibility

Theme

On This Page

constructorautoRestartConfigurationautoShutdownConfigurationdashManifestshlsManifestsliveEncodingModemanifestGeneratorreuploadSettingsstreamKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorautoRestartConfigurationautoShutdownConfigurationdashManifestshlsManifestsliveEncodingModemanifestGeneratorreuploadSettingsstreamKey
\ No newline at end of file diff --git a/docs/classes/StartLiveEncodingRequest.html b/docs/classes/StartLiveEncodingRequest.html index f75d1db73..5271f7a28 100644 --- a/docs/classes/StartLiveEncodingRequest.html +++ b/docs/classes/StartLiveEncodingRequest.html @@ -1,5 +1,5 @@ StartLiveEncodingRequest | @bitmovin/api-sdk

Class StartLiveEncodingRequest

Export

StartLiveEncodingRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoRestartConfiguration? autoShutdownConfiguration? dashManifests? @@ -8,20 +8,20 @@ manifestGenerator? reuploadSettings? streamKey? -

Constructors

constructor

Properties

Optional autoRestartConfiguration

autoRestartConfiguration?: AutoRestartConfiguration

Configuration for auto restarting the live encoding

+

Constructors

constructor

Properties

Optional autoRestartConfiguration

autoRestartConfiguration?: AutoRestartConfiguration

Configuration for auto restarting the live encoding

Memberof

StartLiveEncodingRequest

-

Optional autoShutdownConfiguration

autoShutdownConfiguration?: LiveAutoShutdownConfiguration

Configuration for auto shutdown of the live encoding

+

Optional autoShutdownConfiguration

autoShutdownConfiguration?: LiveAutoShutdownConfiguration

Configuration for auto shutdown of the live encoding

Memberof

StartLiveEncodingRequest

-

Optional dashManifests

dashManifests?: LiveDashManifest[]

DASH manifests to be generated during the encoding. See documentation

+

Optional dashManifests

dashManifests?: LiveDashManifest[]

DASH manifests to be generated during the encoding. See documentation

Memberof

StartLiveEncodingRequest

-

Optional hlsManifests

hlsManifests?: LiveHlsManifest[]

HLS manifests to be generated during the encoding. See documentation

+

Optional hlsManifests

hlsManifests?: LiveHlsManifest[]

HLS manifests to be generated during the encoding. See documentation

Memberof

StartLiveEncodingRequest

-

Optional liveEncodingMode

liveEncodingMode?: EncodingMode

The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.

+

Optional liveEncodingMode

liveEncodingMode?: EncodingMode

The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.

Memberof

StartLiveEncodingRequest

-

Optional manifestGenerator

manifestGenerator?: ManifestGenerator

Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

+

Optional manifestGenerator

manifestGenerator?: ManifestGenerator

Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

Memberof

StartLiveEncodingRequest

-

Optional reuploadSettings

reuploadSettings?: ReuploadSettings

Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage

+

Optional reuploadSettings

reuploadSettings?: ReuploadSettings

Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage

Memberof

StartLiveEncodingRequest

-

Optional streamKey

streamKey?: string

Key for the stream. (a-zA-Z, 3-20 characters) (required)

+

Optional streamKey

streamKey?: string

Key for the stream. (a-zA-Z, 3-20 characters) (required)

Memberof

StartLiveEncodingRequest

-

Settings

Member Visibility

Theme

On This Page

constructorautoRestartConfigurationautoShutdownConfigurationdashManifestshlsManifestsliveEncodingModemanifestGeneratorreuploadSettingsstreamKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorautoRestartConfigurationautoShutdownConfigurationdashManifestshlsManifestsliveEncodingModemanifestGeneratorreuploadSettingsstreamKey
\ No newline at end of file diff --git a/docs/classes/StartManifestRequest.html b/docs/classes/StartManifestRequest.html index 73ef713d5..e721f82bf 100644 --- a/docs/classes/StartManifestRequest.html +++ b/docs/classes/StartManifestRequest.html @@ -1,6 +1,6 @@ StartManifestRequest | @bitmovin/api-sdk

Class StartManifestRequest

Export

StartManifestRequest

-

Constructors

constructor +

Constructors

constructor

Properties

manifestGenerator? -

Constructors

constructor

Properties

Optional manifestGenerator

manifestGenerator?: ManifestGenerator

Major version of the manifest generator to be used. V2 is the recommended option and requires the following minimum encoder versions: 2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

+

Constructors

constructor

Properties

Optional manifestGenerator

manifestGenerator?: ManifestGenerator

Major version of the manifest generator to be used. V2 is the recommended option and requires the following minimum encoder versions: 2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

Memberof

StartManifestRequest

-

Settings

Member Visibility

Theme

On This Page

constructormanifestGenerator
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructormanifestGenerator
\ No newline at end of file diff --git a/docs/classes/StaticIp.html b/docs/classes/StaticIp.html index cde0817e6..f8b2f90d1 100644 --- a/docs/classes/StaticIp.html +++ b/docs/classes/StaticIp.html @@ -1,18 +1,18 @@ StaticIp | @bitmovin/api-sdk

Class StaticIp

Export

StaticIp

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id? infrastructureId? ipAddress? region? status? -

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

+

Constructors

constructor

Properties

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional infrastructureId

infrastructureId?: string

Required if the static IP should be created for an AWS infrastructure account. If this is left blank the static Ip will be created for the managed cloud.

+

Optional infrastructureId

infrastructureId?: string

Required if the static IP should be created for an AWS infrastructure account. If this is left blank the static Ip will be created for the managed cloud.

Memberof

StaticIp

-

Optional ipAddress

ipAddress?: string

The IPv4 address of the static ip

+

Optional ipAddress

ipAddress?: string

The IPv4 address of the static ip

Memberof

StaticIp

-

Optional region

region?: CloudRegion

The region of the static Ip (required)

+

Optional region

region?: CloudRegion

The region of the static Ip (required)

Memberof

StaticIp

-

Optional status

status?: StaticIpStatus

Status of the Static Ip

+

Optional status

status?: StaticIpStatus

Status of the Static Ip

Memberof

StaticIp

-

Settings

Member Visibility

Theme

On This Page

constructoridinfrastructureIdipAddressregionstatus
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridinfrastructureIdipAddressregionstatus
\ No newline at end of file diff --git a/docs/classes/StaticRtmpIngestPoint.html b/docs/classes/StaticRtmpIngestPoint.html index dd7f245ab..216cc9de5 100644 --- a/docs/classes/StaticRtmpIngestPoint.html +++ b/docs/classes/StaticRtmpIngestPoint.html @@ -1,11 +1,11 @@ StaticRtmpIngestPoint | @bitmovin/api-sdk

Class StaticRtmpIngestPoint

Export

StaticRtmpIngestPoint

-

Constructors

constructor +

Constructors

constructor

Properties

id? name? streamKeyConfiguration? -

Constructors

constructor

Properties

Optional id

id?: string

The ID of the created static rtmp ingest point

+

Constructors

constructor

Properties

Optional id

id?: string

The ID of the created static rtmp ingest point

Memberof

StaticRtmpIngestPoint

-

Optional name

name?: string

Name of the ingest point. This can be helpful for easier identifying your ingest points

+

Optional name

name?: string

Name of the ingest point. This can be helpful for easier identifying your ingest points

Memberof

StaticRtmpIngestPoint

-

Optional streamKeyConfiguration

streamKeyConfiguration?: StreamKeyConfiguration

Memberof

StaticRtmpIngestPoint

-

Settings

Member Visibility

Theme

On This Page

constructoridnamestreamKeyConfiguration
\ No newline at end of file +

Optional streamKeyConfiguration

streamKeyConfiguration?: StreamKeyConfiguration

Memberof

StaticRtmpIngestPoint

+

Settings

Member Visibility

Theme

On This Page

constructoridnamestreamKeyConfiguration
\ No newline at end of file diff --git a/docs/classes/Statistics.html b/docs/classes/Statistics.html index 81a10dfb6..6ac7161ad 100644 --- a/docs/classes/Statistics.html +++ b/docs/classes/Statistics.html @@ -1,12 +1,12 @@ Statistics | @bitmovin/api-sdk

Class Statistics

Export

Statistics

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bytesEgressTotal? bytesEncodedTotal? timeEncodedTotal? -

Constructors

constructor

Properties

Optional bytesEgressTotal

bytesEgressTotal?: number

Egress output generated by file transfers in bytes

+

Constructors

constructor

Properties

Optional bytesEgressTotal

bytesEgressTotal?: number

Egress output generated by file transfers in bytes

Memberof

Statistics

-

Optional bytesEncodedTotal

bytesEncodedTotal?: number

Bytes encoded total. (required)

+

Optional bytesEncodedTotal

bytesEncodedTotal?: number

Bytes encoded total. (required)

Memberof

Statistics

-

Optional timeEncodedTotal

timeEncodedTotal?: number

Time in seconds encoded for all contained daily statistics. (required)

+

Optional timeEncodedTotal

timeEncodedTotal?: number

Time in seconds encoded for all contained daily statistics. (required)

Memberof

Statistics

-

Settings

Member Visibility

Theme

On This Page

constructorbytesEgressTotalbytesEncodedTotaltimeEncodedTotal
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbytesEgressTotalbytesEncodedTotaltimeEncodedTotal
\ No newline at end of file diff --git a/docs/classes/StatisticsPerLabel.html b/docs/classes/StatisticsPerLabel.html index d397cc7f9..b0b2c82e3 100644 --- a/docs/classes/StatisticsPerLabel.html +++ b/docs/classes/StatisticsPerLabel.html @@ -1,5 +1,5 @@ StatisticsPerLabel | @bitmovin/api-sdk

Class StatisticsPerLabel

Export

StatisticsPerLabel

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

billableEgressBytes? billableEncodingMinutes? billableFeatureMinutes? @@ -9,22 +9,22 @@ bytesEncodedTotal? label? timeEncodedTotal? -

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Billable egress output

+

Constructors

constructor

Properties

Optional billableEgressBytes

billableEgressBytes?: EgressInformation[]

Billable egress output

Memberof

StatisticsPerLabel

-

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Billable minutes for each encoding configuration

+

Optional billableEncodingMinutes

billableEncodingMinutes?: BillableEncodingMinutes[]

Billable minutes for each encoding configuration

Memberof

StatisticsPerLabel

-

Optional billableFeatureMinutes

billableFeatureMinutes?: BillableEncodingFeatureMinutes[]

Billable minutes for features

+

Optional billableFeatureMinutes

billableFeatureMinutes?: BillableEncodingFeatureMinutes[]

Billable minutes for features

Memberof

StatisticsPerLabel

-

Optional billableMinutes

billableMinutes?: number

The billable minutes.

+

Optional billableMinutes

billableMinutes?: number

The billable minutes.

Memberof

StatisticsPerLabel

-

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for muxings.

+

Optional billableTransmuxingMinutes

billableTransmuxingMinutes?: number

Billable minutes for muxings.

Memberof

StatisticsPerLabel

-

Optional bytesEgressTotal

bytesEgressTotal?: number

Egress output generated by file transfers in bytes

+

Optional bytesEgressTotal

bytesEgressTotal?: number

Egress output generated by file transfers in bytes

Memberof

Statistics

-

Optional bytesEncodedTotal

bytesEncodedTotal?: number

Bytes encoded total. (required)

+

Optional bytesEncodedTotal

bytesEncodedTotal?: number

Bytes encoded total. (required)

Memberof

Statistics

-

Optional label

label?: string

An optional error message, when the event is in error state (occurs at event: ERROR) (required)

+

Optional label

label?: string

An optional error message, when the event is in error state (occurs at event: ERROR) (required)

Memberof

StatisticsPerLabel

-

Optional timeEncodedTotal

timeEncodedTotal?: number

Time in seconds encoded for all contained daily statistics. (required)

+

Optional timeEncodedTotal

timeEncodedTotal?: number

Time in seconds encoded for all contained daily statistics. (required)

Memberof

Statistics

-

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableMinutesbillableTransmuxingMinutesbytesEgressTotalbytesEncodedTotallabeltimeEncodedTotal
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableEgressBytesbillableEncodingMinutesbillableFeatureMinutesbillableMinutesbillableTransmuxingMinutesbytesEgressTotalbytesEncodedTotallabeltimeEncodedTotal
\ No newline at end of file diff --git a/docs/classes/StatisticsPerMuxing.html b/docs/classes/StatisticsPerMuxing.html index 2bddfc18f..0eaab3ac0 100644 --- a/docs/classes/StatisticsPerMuxing.html +++ b/docs/classes/StatisticsPerMuxing.html @@ -1,20 +1,20 @@ StatisticsPerMuxing | @bitmovin/api-sdk

Class StatisticsPerMuxing

Export

StatisticsPerMuxing

-

Constructors

constructor +

Constructors

constructor

Properties

billableMinutes? encodedBytes? multiplicator? muxingId? muxingType? streamId? -

Constructors

constructor

Properties

Optional billableMinutes

billableMinutes?: number

Resulting minutes you will be charged for. (required)

+

Constructors

constructor

Properties

Optional billableMinutes

billableMinutes?: number

Resulting minutes you will be charged for. (required)

Memberof

StatisticsPerMuxing

-

Optional encodedBytes

encodedBytes?: number

Encoded bytes. (required)

+

Optional encodedBytes

encodedBytes?: number

Encoded bytes. (required)

Memberof

StatisticsPerMuxing

-

Optional multiplicator

multiplicator?: number

Multiplier for the encoded minutes. Depends on muxing type. (required)

+

Optional multiplicator

multiplicator?: number

Multiplier for the encoded minutes. Depends on muxing type. (required)

Memberof

StatisticsPerMuxing

-

Optional muxingId

muxingId?: string

ID of the muxing (required)

+

Optional muxingId

muxingId?: string

ID of the muxing (required)

Memberof

StatisticsPerMuxing

-

Optional muxingType

muxingType?: MuxingType

Memberof

StatisticsPerMuxing

-

Optional streamId

streamId?: string

ID of the stream (required)

+

Optional muxingType

muxingType?: MuxingType

Memberof

StatisticsPerMuxing

+

Optional streamId

streamId?: string

ID of the stream (required)

Memberof

StatisticsPerMuxing

-

Settings

Member Visibility

Theme

On This Page

constructorbillableMinutesencodedBytesmultiplicatormuxingIdmuxingTypestreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableMinutesencodedBytesmultiplicatormuxingIdmuxingTypestreamId
\ No newline at end of file diff --git a/docs/classes/StatisticsPerStream.html b/docs/classes/StatisticsPerStream.html index 0cf2c3922..99cd2cd32 100644 --- a/docs/classes/StatisticsPerStream.html +++ b/docs/classes/StatisticsPerStream.html @@ -1,5 +1,5 @@ StatisticsPerStream | @bitmovin/api-sdk

Class StatisticsPerStream

Export

StatisticsPerStream

-

Constructors

constructor +

Constructors

constructor

Properties

billableMinutes? bitrate? codec? @@ -37,69 +37,69 @@ resolution? streamId? width? -

Constructors

constructor

Properties

Optional billableMinutes

billableMinutes?: number

Minutes you will be charged for (billableMinutes = encodedSeconds * multiplicator) (required)

+

Constructors

constructor

Properties

Optional billableMinutes

billableMinutes?: number

Minutes you will be charged for (billableMinutes = encodedSeconds * multiplicator) (required)

Memberof

StatisticsPerStream

-

Optional bitrate

bitrate?: number

Bitrate of the stream (required)

+

Optional bitrate

bitrate?: number

Bitrate of the stream (required)

Memberof

StatisticsPerStream

-

Optional codec

codec?: CodecConfigType

Memberof

StatisticsPerStream

-

Optional codecConfigId

codecConfigId?: string

ID of the condec configuration (required)

+

Optional codec

codec?: CodecConfigType

Memberof

StatisticsPerStream

+

Optional codecConfigId

codecConfigId?: string

ID of the condec configuration (required)

Memberof

StatisticsPerStream

-

Optional dolbyVisionMode

dolbyVisionMode?: DolbyVisionPerStreamMode

Memberof

StatisticsPerStream

-

Optional dolbyVisionMultiplicator

dolbyVisionMultiplicator?: number

The output minutes multiplicator for Dolby Vision streams

+

Optional dolbyVisionMode

dolbyVisionMode?: DolbyVisionPerStreamMode

Memberof

StatisticsPerStream

+

Optional dolbyVisionMultiplicator

dolbyVisionMultiplicator?: number

The output minutes multiplicator for Dolby Vision streams

Memberof

StatisticsPerStream

-

Optional dolbyVisionToHdr

dolbyVisionToHdr?: boolean

Indicates if the conversion from Dolby Vision to HDR was triggered.

+

Optional dolbyVisionToHdr

dolbyVisionToHdr?: boolean

Indicates if the conversion from Dolby Vision to HDR was triggered.

Memberof

StatisticsPerStream

-

Optional dolbyVisionToHdrMultiplicator

dolbyVisionToHdrMultiplicator?: number

The output minutes multiplicator for streams using the conversion from Dolby Vision to HDR.

+

Optional dolbyVisionToHdrMultiplicator

dolbyVisionToHdrMultiplicator?: number

The output minutes multiplicator for streams using the conversion from Dolby Vision to HDR.

Memberof

StatisticsPerStream

-

Optional dolbyVisionToSdr

dolbyVisionToSdr?: boolean

Indicates if the conversion from Dolby Vision to SDR was triggered.

+

Optional dolbyVisionToSdr

dolbyVisionToSdr?: boolean

Indicates if the conversion from Dolby Vision to SDR was triggered.

Memberof

StatisticsPerStream

-

Optional dolbyVisionToSdrMultiplicator

dolbyVisionToSdrMultiplicator?: number

The output minutes multiplicator for streams using the conversion from Dolby Vision to SDR.

+

Optional dolbyVisionToSdrMultiplicator

dolbyVisionToSdrMultiplicator?: number

The output minutes multiplicator for streams using the conversion from Dolby Vision to SDR.

Memberof

StatisticsPerStream

-

Optional encodedBytes

encodedBytes?: number

Encoded bytes. (required)

+

Optional encodedBytes

encodedBytes?: number

Encoded bytes. (required)

Memberof

StatisticsPerStream

-

Optional encodedSeconds

encodedSeconds?: number

Length of the stream. (required)

+

Optional encodedSeconds

encodedSeconds?: number

Length of the stream. (required)

Memberof

StatisticsPerStream

-

Optional encodingMode

encodingMode?: EncodingMode

Memberof

StatisticsPerStream

-

Optional encodingModeMultiplicator

encodingModeMultiplicator?: number

The output minutes multiplicator for the given encodingMode

+

Optional encodingMode

encodingMode?: EncodingMode

Memberof

StatisticsPerStream

+

Optional encodingModeMultiplicator

encodingModeMultiplicator?: number

The output minutes multiplicator for the given encodingMode

Memberof

StatisticsPerStream

-

Optional enhancedDeinterlace

enhancedDeinterlace?: boolean

Indicates if an enhanced interlace filter was used.

+

Optional enhancedDeinterlace

enhancedDeinterlace?: boolean

Indicates if an enhanced interlace filter was used.

Memberof

StatisticsPerStream

-

Optional enhancedDeinterlaceMultiplicator

enhancedDeinterlaceMultiplicator?: number

The output minutes multiplicator for streams using an enhanced Deinterlace Filter.

+

Optional enhancedDeinterlaceMultiplicator

enhancedDeinterlaceMultiplicator?: number

The output minutes multiplicator for streams using an enhanced Deinterlace Filter.

Memberof

StatisticsPerStream

-

Optional hdrHlgToSdr

hdrHlgToSdr?: boolean

Indicates if the conversion from HDR10/HLG to SDR was triggered.

+

Optional hdrHlgToSdr

hdrHlgToSdr?: boolean

Indicates if the conversion from HDR10/HLG to SDR was triggered.

Memberof

StatisticsPerStream

-

Optional hdrHlgToSdrMultiplicator

hdrHlgToSdrMultiplicator?: number

The output minutes multiplicator for streams using the conversion from HDR10/HLG to SDR.

+

Optional hdrHlgToSdrMultiplicator

hdrHlgToSdrMultiplicator?: number

The output minutes multiplicator for streams using the conversion from HDR10/HLG to SDR.

Memberof

StatisticsPerStream

-

Optional height

height?: number

Video height, only if video stream

+

Optional height

height?: number

Video height, only if video stream

Memberof

StatisticsPerStream

-

Optional inputFactor

inputFactor?: InputFactor

Memberof

StatisticsPerStream

-

Optional live

live?: boolean

Indicates if the stream was part of a live encoding.

+

Optional inputFactor

inputFactor?: InputFactor

Memberof

StatisticsPerStream

+

Optional live

live?: boolean

Indicates if the stream was part of a live encoding.

Memberof

StatisticsPerStream

-

Optional liveMultiplicator

liveMultiplicator?: number

The output minutes multiplicator for live streams.

+

Optional liveMultiplicator

liveMultiplicator?: number

The output minutes multiplicator for live streams.

Memberof

StatisticsPerStream

-

Optional multiplicator

multiplicator?: number

Multiplier for the encoded minutes. Depends on muxing type. (required)

+

Optional multiplicator

multiplicator?: number

Multiplier for the encoded minutes. Depends on muxing type. (required)

Memberof

StatisticsPerStream

-

Optional nexGuardABWatermarkingMultiplicator

nexGuardABWatermarkingMultiplicator?: number

The output minutes multiplicator for streams using a NexGuard A/B Watermarking.

+

Optional nexGuardABWatermarkingMultiplicator

nexGuardABWatermarkingMultiplicator?: number

The output minutes multiplicator for streams using a NexGuard A/B Watermarking.

Memberof

StatisticsPerStream

-

Optional nexGuardABWatermarkingType

nexGuardABWatermarkingType?: NexGuardABWatermarkingFeature

Memberof

StatisticsPerStream

-

Optional perTitleMultiplicator

perTitleMultiplicator?: number

The output minutes multiplicator for per-title

+

Optional nexGuardABWatermarkingType

nexGuardABWatermarkingType?: NexGuardABWatermarkingFeature

Memberof

StatisticsPerStream

+

Optional perTitleMultiplicator

perTitleMultiplicator?: number

The output minutes multiplicator for per-title

Memberof

StatisticsPerStream

-

Optional perTitleResultStream

perTitleResultStream?: StatisticsPerTitleStream

Memberof

StatisticsPerStream

-

Optional pixelFormatBitDepth

pixelFormatBitDepth?: PixelFormatBitDepth

Memberof

StatisticsPerStream

-

Optional pixelFormatMultiplicator

pixelFormatMultiplicator?: number

The output minutes multiplicator for the pixel format bit depth

+

Optional perTitleResultStream

perTitleResultStream?: StatisticsPerTitleStream

Memberof

StatisticsPerStream

+

Optional pixelFormatBitDepth

pixelFormatBitDepth?: PixelFormatBitDepth

Memberof

StatisticsPerStream

+

Optional pixelFormatMultiplicator

pixelFormatMultiplicator?: number

The output minutes multiplicator for the pixel format bit depth

Memberof

StatisticsPerStream

-

Optional preset

preset?: string

Name of the preset configuration used for the codec configuration or "CUSTOM" if any preset values were overridden

+

Optional preset

preset?: string

Name of the preset configuration used for the codec configuration or "CUSTOM" if any preset values were overridden

Memberof

StatisticsPerStream

-

Optional presetMultiplicator

presetMultiplicator?: number

The output minutes multiplicator for the used codec configuration preset.

+

Optional presetMultiplicator

presetMultiplicator?: number

The output minutes multiplicator for the used codec configuration preset.

Memberof

StatisticsPerStream

-

Optional psnrMode

psnrMode?: PsnrPerStreamMode

Memberof

StatisticsPerStream

-

Optional psnrMultiplicator

psnrMultiplicator?: number

The output minutes multiplicator for psnr streams

+

Optional psnrMode

psnrMode?: PsnrPerStreamMode

Memberof

StatisticsPerStream

+

Optional psnrMultiplicator

psnrMultiplicator?: number

The output minutes multiplicator for psnr streams

Memberof

StatisticsPerStream

-

Optional rate

rate?: number

If it' a video stream this value is the FPS, for audio it's the sample rate. (required)

+

Optional rate

rate?: number

If it' a video stream this value is the FPS, for audio it's the sample rate. (required)

Memberof

StatisticsPerStream

-

Optional resolution

resolution?: StatisticsResolution

Memberof

StatisticsPerStream

-

Optional streamId

streamId?: string

ID of the stream (required)

+

Optional resolution

resolution?: StatisticsResolution

Memberof

StatisticsPerStream

+

Optional streamId

streamId?: string

ID of the stream (required)

Memberof

StatisticsPerStream

-

Optional width

width?: number

Video width, only if video stream

+

Optional width

width?: number

Video width, only if video stream

Memberof

StatisticsPerStream

-

Settings

Member Visibility

Theme

On This Page

constructorbillableMinutesbitratecodeccodecConfigIddolbyVisionModedolbyVisionMultiplicatordolbyVisionToHdrdolbyVisionToHdrMultiplicatordolbyVisionToSdrdolbyVisionToSdrMultiplicatorencodedBytesencodedSecondsencodingModeencodingModeMultiplicatorenhancedDeinterlaceenhancedDeinterlaceMultiplicatorhdrHlgToSdrhdrHlgToSdrMultiplicatorheightinputFactorliveliveMultiplicatormultiplicatornexGuardABWatermarkingMultiplicatornexGuardABWatermarkingTypeperTitleMultiplicatorperTitleResultStreampixelFormatBitDepthpixelFormatMultiplicatorpresetpresetMultiplicatorpsnrModepsnrMultiplicatorrateresolutionstreamIdwidth
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbillableMinutesbitratecodeccodecConfigIddolbyVisionModedolbyVisionMultiplicatordolbyVisionToHdrdolbyVisionToHdrMultiplicatordolbyVisionToSdrdolbyVisionToSdrMultiplicatorencodedBytesencodedSecondsencodingModeencodingModeMultiplicatorenhancedDeinterlaceenhancedDeinterlaceMultiplicatorhdrHlgToSdrhdrHlgToSdrMultiplicatorheightinputFactorliveliveMultiplicatormultiplicatornexGuardABWatermarkingMultiplicatornexGuardABWatermarkingTypeperTitleMultiplicatorperTitleResultStreampixelFormatBitDepthpixelFormatMultiplicatorpresetpresetMultiplicatorpsnrModepsnrMultiplicatorrateresolutionstreamIdwidth
\ No newline at end of file diff --git a/docs/classes/Stream.html b/docs/classes/Stream.html index a04b4b91e..5d87c2b19 100644 --- a/docs/classes/Stream.html +++ b/docs/classes/Stream.html @@ -1,5 +1,5 @@ Stream | @bitmovin/api-sdk

Class Stream

Export

Stream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

appliedSettings? codecConfigId? conditions? @@ -19,40 +19,40 @@ perTitleSettings? segmentsEncoded? selectedEncodingMode? -

Constructors

constructor

Properties

Optional appliedSettings

appliedSettings?: AppliedStreamSettings

Contains stream properties which may not have been defined in the configuration

+

Constructors

constructor

Properties

Optional appliedSettings

appliedSettings?: AppliedStreamSettings

Contains stream properties which may not have been defined in the configuration

Memberof

Stream

-

Optional codecConfigId

codecConfigId?: string

Id of the codec configuration (required)

+

Optional codecConfigId

codecConfigId?: string

Id of the codec configuration (required)

Memberof

Stream

-

Optional conditions

conditions?: AbstractCondition

Defines a condition that is evaluated against the input of the Stream. If the condition is not fulfilled, the Stream will be ignored during the encoding process. The 'streamConditionMode' of a Muxing allows to control how ignored Streams affect the Muxing. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored. See Stream Conditions for more information

+

Optional conditions

conditions?: AbstractCondition

Defines a condition that is evaluated against the input of the Stream. If the condition is not fulfilled, the Stream will be ignored during the encoding process. The 'streamConditionMode' of a Muxing allows to control how ignored Streams affect the Muxing. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored. See Stream Conditions for more information

Memberof

Stream

-

Optional createQualityMetaData

createQualityMetaData?: boolean

Set true to create quality metadata for this stream

+

Optional createQualityMetaData

createQualityMetaData?: boolean

Set true to create quality metadata for this stream

Memberof

Stream

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional decodingErrorMode

decodingErrorMode?: DecodingErrorMode

Determines how to react to errors during decoding

+

Optional decodingErrorMode

decodingErrorMode?: DecodingErrorMode

Determines how to react to errors during decoding

Memberof

Stream

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Stream has been ignored during the encoding process due to its 'conditions'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Stream has been ignored during the encoding process due to its 'conditions'

Memberof

Stream

-

Optional inputStreams

inputStreams?: StreamInput[]

Determines the input source(s) for the stream. All video streams of an encoding need to have identical input configurations (required)

+

Optional inputStreams

inputStreams?: StreamInput[]

Determines the input source(s) for the stream. All video streams of an encoding need to have identical input configurations (required)

Memberof

Stream

-

Optional metadata

metadata?: StreamMetadata

Memberof

Stream

-

Optional mode

mode?: StreamMode

Mode of the stream

+

Optional metadata

metadata?: StreamMetadata

Memberof

Stream

+

Optional mode

mode?: StreamMode

Mode of the stream

Memberof

Stream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Stream

-

Optional perTitleSettings

perTitleSettings?: StreamPerTitleSettings

Settings to configure Per-Title on stream level

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Stream

+

Optional perTitleSettings

perTitleSettings?: StreamPerTitleSettings

Settings to configure Per-Title on stream level

Memberof

Stream

-

Optional segmentsEncoded

segmentsEncoded?: number

Number of encoded segments. Available after encoding finishes.

+

Optional segmentsEncoded

segmentsEncoded?: number

Number of encoded segments. Available after encoding finishes.

Memberof

Stream

-

Optional selectedEncodingMode

selectedEncodingMode?: EncodingMode

The encoding mode that was used for this stream. This is derived from encodingMode, which can be specified in the codec configuration or in the encoding start request. Note that all streams of an encoding need to use the same encoding mode. This will therefore always match selectedEncodingMode of the related Encoding resource. Especially useful when encodingMode was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).

+

Optional selectedEncodingMode

selectedEncodingMode?: EncodingMode

The encoding mode that was used for this stream. This is derived from encodingMode, which can be specified in the codec configuration or in the encoding start request. Note that all streams of an encoding need to use the same encoding mode. This will therefore always match selectedEncodingMode of the related Encoding resource. Especially useful when encodingMode was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).

Memberof

Stream

-

Settings

Member Visibility

Theme

On This Page

constructorappliedSettingscodecConfigIdconditionscreateQualityMetaDatacreatedAtcustomDatadecodingErrorModedescriptionidignoredByinputStreamsmetadatamodemodifiedAtnameoutputsperTitleSettingssegmentsEncodedselectedEncodingMode
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorappliedSettingscodecConfigIdconditionscreateQualityMetaDatacreatedAtcustomDatadecodingErrorModedescriptionidignoredByinputStreamsmetadatamodemodifiedAtnameoutputsperTitleSettingssegmentsEncodedselectedEncodingMode
\ No newline at end of file diff --git a/docs/classes/StreamFilter.html b/docs/classes/StreamFilter.html index 44c49ec03..435dd3058 100644 --- a/docs/classes/StreamFilter.html +++ b/docs/classes/StreamFilter.html @@ -1,9 +1,9 @@ StreamFilter | @bitmovin/api-sdk

Class StreamFilter

Export

StreamFilter

-

Constructors

constructor +

Constructors

constructor

Properties

id? position? -

Constructors

constructor

Properties

Optional id

id?: string

The id of the filter that should be used in the stream (required)

+

Constructors

constructor

Properties

Optional id

id?: string

The id of the filter that should be used in the stream (required)

Memberof

StreamFilter

-

Optional position

position?: number

Defines the order in which filters are applied. Filters are applied in ascending order. (required)

+

Optional position

position?: number

Defines the order in which filters are applied. Filters are applied in ascending order. (required)

Memberof

StreamFilter

-

Settings

Member Visibility

Theme

On This Page

constructoridposition
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridposition
\ No newline at end of file diff --git a/docs/classes/StreamFilterList.html b/docs/classes/StreamFilterList.html index 28409c3e5..95fdce085 100644 --- a/docs/classes/StreamFilterList.html +++ b/docs/classes/StreamFilterList.html @@ -1,6 +1,6 @@ StreamFilterList | @bitmovin/api-sdk

Class StreamFilterList

Export

StreamFilterList

-

Constructors

constructor +

Constructors

constructor

Properties

filters? -

Constructors

constructor

Properties

Optional filters

filters?: StreamFilter[]

List of stream filters (required)

+

Constructors

constructor

Properties

Optional filters

filters?: StreamFilter[]

List of stream filters (required)

Memberof

StreamFilterList

-

Settings

Member Visibility

Theme

On This Page

constructorfilters
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorfilters
\ No newline at end of file diff --git a/docs/classes/StreamInfo.html b/docs/classes/StreamInfo.html index a34f7ddea..7e21406c1 100644 --- a/docs/classes/StreamInfo.html +++ b/docs/classes/StreamInfo.html @@ -1,5 +1,5 @@ StreamInfo | @bitmovin/api-sdk

Class StreamInfo

Export

StreamInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audio? audioGroups? closedCaptions? @@ -21,46 +21,46 @@ subtitles? uri? video? -

Constructors

constructor

Properties

Optional audio

audio?: string

It MUST match the value of the GROUP-ID attribute of an Audio EXT-X-MEDIA tag elsewhere in the Master Playlist. Either this or audioGroups must be set.

+

Constructors

constructor

Properties

Optional audio

audio?: string

It MUST match the value of the GROUP-ID attribute of an Audio EXT-X-MEDIA tag elsewhere in the Master Playlist. Either this or audioGroups must be set.

Memberof

StreamInfo

-

Optional audioGroups

audioGroups?: AudioGroupConfiguration

HLS Audio Group Configuration. You will want to use this configuration property in case you specify conditions on audio streams. The first matching audio group will be used for the specific variant stream. Either this or audio must be set.

+

Optional audioGroups

audioGroups?: AudioGroupConfiguration

HLS Audio Group Configuration. You will want to use this configuration property in case you specify conditions on audio streams. The first matching audio group will be used for the specific variant stream. Either this or audio must be set.

Memberof

StreamInfo

-

Optional closedCaptions

closedCaptions?: string

If the value is not 'NONE', it MUST match the value of the GROUP-ID attribute of a Closed Captions EXT-X-MEDIA tag elsewhere in the Playlist (required)

+

Optional closedCaptions

closedCaptions?: string

If the value is not 'NONE', it MUST match the value of the GROUP-ID attribute of a Closed Captions EXT-X-MEDIA tag elsewhere in the Playlist (required)

Memberof

StreamInfo

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional drmId

drmId?: string

Id of the DRM.

+

Optional drmId

drmId?: string

Id of the DRM.

Memberof

StreamInfo

-

Optional encodingId

encodingId?: string

Id of the encoding. (required)

+

Optional encodingId

encodingId?: string

Id of the encoding. (required)

Memberof

StreamInfo

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

Memberof

StreamInfo

-

Optional forceFrameRateAttribute

forceFrameRateAttribute?: boolean

Force the addition of the frame rate attribute to all stream infos.

+

Optional forceFrameRateAttribute

forceFrameRateAttribute?: boolean

Force the addition of the frame rate attribute to all stream infos.

Memberof

StreamInfo

-

Optional forceVideoRangeAttribute

forceVideoRangeAttribute?: boolean

Force the addition of the video-range attribute to all stream infos.

+

Optional forceVideoRangeAttribute

forceVideoRangeAttribute?: boolean

Force the addition of the video-range attribute to all stream infos.

Memberof

StreamInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

StreamInfo

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional segmentPath

segmentPath?: string

Path to segments. (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. (required)

Memberof

StreamInfo

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

Memberof

StreamInfo

-

Optional streamId

streamId?: string

Id of the stream. (required)

+

Optional streamId

streamId?: string

Id of the stream. (required)

Memberof

StreamInfo

-

Optional subtitles

subtitles?: string

It MUST match the value of the GROUP-ID attribute of a Subtitles EXT-X-MEDIA tag elsewhere in the Master Playlist

+

Optional subtitles

subtitles?: string

It MUST match the value of the GROUP-ID attribute of a Subtitles EXT-X-MEDIA tag elsewhere in the Master Playlist

Memberof

StreamInfo

-

Optional uri

uri?: string

The URI of the playlist file. (required)

+

Optional uri

uri?: string

The URI of the playlist file. (required)

Memberof

StreamInfo

-

Optional video

video?: string

It MUST match the value of the GROUP-ID attribute of a Video EXT-X-MEDIA tag elsewhere in the Master Playlist

+

Optional video

video?: string

It MUST match the value of the GROUP-ID attribute of a Video EXT-X-MEDIA tag elsewhere in the Master Playlist

Memberof

StreamInfo

-

Settings

Member Visibility

Theme

On This Page

constructoraudioaudioGroupsclosedCaptionscreatedAtcustomDatadescriptiondrmIdencodingIdendSegmentNumberforceFrameRateAttributeforceVideoRangeAttributeidmodifiedAtmuxingIdnamesegmentPathstartSegmentNumberstreamIdsubtitlesurivideo
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioaudioGroupsclosedCaptionscreatedAtcustomDatadescriptiondrmIdencodingIdendSegmentNumberforceFrameRateAttributeforceVideoRangeAttributeidmodifiedAtmuxingIdnamesegmentPathstartSegmentNumberstreamIdsubtitlesurivideo
\ No newline at end of file diff --git a/docs/classes/StreamInfos.html b/docs/classes/StreamInfos.html index c2e394c3b..6f1301dbe 100644 --- a/docs/classes/StreamInfos.html +++ b/docs/classes/StreamInfos.html @@ -1,9 +1,9 @@ StreamInfos | @bitmovin/api-sdk

Class StreamInfos

Export

StreamInfos

-

Constructors

constructor +

Constructors

constructor

Properties

streamInfos? time? -

Constructors

constructor

Properties

Optional streamInfos

streamInfos?: StreamInfosDetails[]

Details about billable minutes for each resolution category

+

Constructors

constructor

Properties

Optional streamInfos

streamInfos?: StreamInfosDetails[]

Details about billable minutes for each resolution category

Memberof

StreamInfos

-

Optional time

time?: Date

Timestamp of the event, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)

+

Optional time

time?: Date

Timestamp of the event, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)

Memberof

StreamInfos

-

Settings

Member Visibility

Theme

On This Page

constructorstreamInfostime
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorstreamInfostime
\ No newline at end of file diff --git a/docs/classes/StreamInfosDetails.html b/docs/classes/StreamInfosDetails.html index a9cbfd12d..89dc1762f 100644 --- a/docs/classes/StreamInfosDetails.html +++ b/docs/classes/StreamInfosDetails.html @@ -1,5 +1,5 @@ StreamInfosDetails | @bitmovin/api-sdk

Class StreamInfosDetails

Export

StreamInfosDetails

-

Constructors

constructor +

Constructors

constructor

Properties

bytesBackupPerSecondAvg? bytesBackupPerSecondMax? bytesBackupPerSecondMin? @@ -18,40 +18,40 @@ samplesReadPerSecondMax? samplesReadPerSecondMin? width? -

Constructors

constructor

Properties

Optional bytesBackupPerSecondAvg

bytesBackupPerSecondAvg?: number

The average amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

+

Constructors

constructor

Properties

Optional bytesBackupPerSecondAvg

bytesBackupPerSecondAvg?: number

The average amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

Memberof

StreamInfosDetails

-

Optional bytesBackupPerSecondMax

bytesBackupPerSecondMax?: number

The maximum amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

+

Optional bytesBackupPerSecondMax

bytesBackupPerSecondMax?: number

The maximum amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

Memberof

StreamInfosDetails

-

Optional bytesBackupPerSecondMin

bytesBackupPerSecondMin?: number

The minimum amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

+

Optional bytesBackupPerSecondMin

bytesBackupPerSecondMin?: number

The minimum amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

Memberof

StreamInfosDetails

-

Optional bytesReadPerSecondAvg

bytesReadPerSecondAvg?: number

The average bytes read per second within the last minute (required)

+

Optional bytesReadPerSecondAvg

bytesReadPerSecondAvg?: number

The average bytes read per second within the last minute (required)

Memberof

StreamInfosDetails

-

Optional bytesReadPerSecondMax

bytesReadPerSecondMax?: number

The maximum bytes read per second within the last minute (required)

+

Optional bytesReadPerSecondMax

bytesReadPerSecondMax?: number

The maximum bytes read per second within the last minute (required)

Memberof

StreamInfosDetails

-

Optional bytesReadPerSecondMin

bytesReadPerSecondMin?: number

The minimum bytes read per second within the last minute (required)

+

Optional bytesReadPerSecondMin

bytesReadPerSecondMin?: number

The minimum bytes read per second within the last minute (required)

Memberof

StreamInfosDetails

-

Optional codec

codec?: LiveEncodingCodec

The codec of the input stream (required)

+

Optional codec

codec?: LiveEncodingCodec

The codec of the input stream (required)

Memberof

StreamInfosDetails

-

Optional height

height?: number

The height of the stream, if it is a video stream

+

Optional height

height?: number

The height of the stream, if it is a video stream

Memberof

StreamInfosDetails

-

Optional id

id?: string

The id of the stream (required)

+

Optional id

id?: string

The id of the stream (required)

Memberof

StreamInfosDetails

-

Optional mediaType

mediaType?: MediaType

The media type of the stream (required)

+

Optional mediaType

mediaType?: MediaType

The media type of the stream (required)

Memberof

StreamInfosDetails

-

Optional rate

rate?: number

The rate (sample rate / fps) of the stream (required)

+

Optional rate

rate?: number

The rate (sample rate / fps) of the stream (required)

Memberof

StreamInfosDetails

-

Optional samplesBackupPerSecondAvg

samplesBackupPerSecondAvg?: number

The average amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

+

Optional samplesBackupPerSecondAvg

samplesBackupPerSecondAvg?: number

The average amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

Memberof

StreamInfosDetails

-

Optional samplesBackupPerSecondMax

samplesBackupPerSecondMax?: number

The maximum amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

+

Optional samplesBackupPerSecondMax

samplesBackupPerSecondMax?: number

The maximum amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

Memberof

StreamInfosDetails

-

Optional samplesBackupPerSecondMin

samplesBackupPerSecondMin?: number

The minimum amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

+

Optional samplesBackupPerSecondMin

samplesBackupPerSecondMin?: number

The minimum amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)

Memberof

StreamInfosDetails

-

Optional samplesReadPerSecondAvg

samplesReadPerSecondAvg?: number

The average samples read per second within the last minute (required)

+

Optional samplesReadPerSecondAvg

samplesReadPerSecondAvg?: number

The average samples read per second within the last minute (required)

Memberof

StreamInfosDetails

-

Optional samplesReadPerSecondMax

samplesReadPerSecondMax?: number

The maximum samples read per second within the last minute (required)

+

Optional samplesReadPerSecondMax

samplesReadPerSecondMax?: number

The maximum samples read per second within the last minute (required)

Memberof

StreamInfosDetails

-

Optional samplesReadPerSecondMin

samplesReadPerSecondMin?: number

The minimum samples read per second within the last minute (required)

+

Optional samplesReadPerSecondMin

samplesReadPerSecondMin?: number

The minimum samples read per second within the last minute (required)

Memberof

StreamInfosDetails

-

Optional width

width?: number

The width of the stream, if it is a video stream

+

Optional width

width?: number

The width of the stream, if it is a video stream

Memberof

StreamInfosDetails

-

Settings

Member Visibility

Theme

On This Page

constructorbytesBackupPerSecondAvgbytesBackupPerSecondMaxbytesBackupPerSecondMinbytesReadPerSecondAvgbytesReadPerSecondMaxbytesReadPerSecondMincodecheightidmediaTyperatesamplesBackupPerSecondAvgsamplesBackupPerSecondMaxsamplesBackupPerSecondMinsamplesReadPerSecondAvgsamplesReadPerSecondMaxsamplesReadPerSecondMinwidth
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbytesBackupPerSecondAvgbytesBackupPerSecondMaxbytesBackupPerSecondMinbytesReadPerSecondAvgbytesReadPerSecondMaxbytesReadPerSecondMincodecheightidmediaTyperatesamplesBackupPerSecondAvgsamplesBackupPerSecondMaxsamplesBackupPerSecondMinsamplesReadPerSecondAvgsamplesReadPerSecondMaxsamplesReadPerSecondMinwidth
\ No newline at end of file diff --git a/docs/classes/StreamInput.html b/docs/classes/StreamInput.html index d958a4710..7026da2af 100644 --- a/docs/classes/StreamInput.html +++ b/docs/classes/StreamInput.html @@ -1,21 +1,21 @@ StreamInput | @bitmovin/api-sdk

Class StreamInput

Export

StreamInput

-

Constructors

constructor +

Constructors

constructor

Properties

analysisDetails? inputId? inputPath? inputStreamId? position? selectionMode? -

Constructors

constructor

Properties

Optional analysisDetails

analysisDetails?: EncodingStreamInputDetails

Input analysis details This property is populated after the encoding has finished

+

Constructors

constructor

Properties

Optional analysisDetails

analysisDetails?: EncodingStreamInputDetails

Input analysis details This property is populated after the encoding has finished

Memberof

StreamInput

-

Optional inputId

inputId?: string

ID of an Input resource defining the input storage. Required if 'inputStreamId' is not set.

+

Optional inputId

inputId?: string

ID of an Input resource defining the input storage. Required if 'inputStreamId' is not set.

Memberof

StreamInput

-

Optional inputPath

inputPath?: string

Path to an input media file. Required if 'inputStreamId' is not set.

+

Optional inputPath

inputPath?: string

Path to an input media file. Required if 'inputStreamId' is not set.

Memberof

StreamInput

-

Optional inputStreamId

inputStreamId?: string

Set this property instead of all others to reference an InputStream resource (e.g. an Ingest-, Trimming- or ConcatenationInputStream)

+

Optional inputStreamId

inputStreamId?: string

Set this property instead of all others to reference an InputStream resource (e.g. an Ingest-, Trimming- or ConcatenationInputStream)

Memberof

StreamInput

-

Optional position

position?: number

Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.

+

Optional position

position?: number

Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.

Memberof

StreamInput

-

Optional selectionMode

selectionMode?: StreamSelectionMode

Specifies the strategy for selecting a stream from the input file. Must not be set when 'inputStreamId' is set.

+

Optional selectionMode

selectionMode?: StreamSelectionMode

Specifies the strategy for selecting a stream from the input file. Must not be set when 'inputStreamId' is set.

Memberof

StreamInput

-

Settings

Member Visibility

Theme

On This Page

constructoranalysisDetailsinputIdinputPathinputStreamIdpositionselectionMode
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoranalysisDetailsinputIdinputPathinputStreamIdpositionselectionMode
\ No newline at end of file diff --git a/docs/classes/StreamKey.html b/docs/classes/StreamKey.html index 90a075756..e427a48b4 100644 --- a/docs/classes/StreamKey.html +++ b/docs/classes/StreamKey.html @@ -1,5 +1,5 @@ StreamKey | @bitmovin/api-sdk

Class StreamKey

Export

StreamKey

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assignedEncodingId? assignedIngestPointId? createdAt? @@ -11,26 +11,26 @@ status? type? value? -

Constructors

constructor

Properties

Optional assignedEncodingId

assignedEncodingId?: string

ID of the encoding that is assigned to this stream key. Not set if status is UNASSIGNED

+

Constructors

constructor

Properties

Optional assignedEncodingId

assignedEncodingId?: string

ID of the encoding that is assigned to this stream key. Not set if status is UNASSIGNED

Memberof

StreamKey

-

Optional assignedIngestPointId

assignedIngestPointId?: string

ID of the ingest point that is assigned to this stream key. Not set if status is UNASSIGNED

+

Optional assignedIngestPointId

assignedIngestPointId?: string

ID of the ingest point that is assigned to this stream key. Not set if status is UNASSIGNED

Memberof

StreamKey

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional status

status?: StreamKeyStatus

Status of the stream key

+

Optional status

status?: StreamKeyStatus

Status of the stream key

Memberof

StreamKey

-

Optional type

type?: StreamKeyType

Type of the stream key

+

Optional type

type?: StreamKeyType

Type of the stream key

Memberof

StreamKey

-

Optional value

value?: string

Stream key used for live streaming. This stream key is reserved and can be re-used with different live encodings. If this value is not provided, a unique random stream key will be generated. Important: This value has to be globally unique. If it is set manually, be sure to use a secure value. If the stream key value is guessed by others your live encoding can be compromised.

+

Optional value

value?: string

Stream key used for live streaming. This stream key is reserved and can be re-used with different live encodings. If this value is not provided, a unique random stream key will be generated. Important: This value has to be globally unique. If it is set manually, be sure to use a secure value. If the stream key value is guessed by others your live encoding can be compromised.

Memberof

StreamKey

-

Settings

Member Visibility

Theme

On This Page

constructorassignedEncodingIdassignedIngestPointIdcreatedAtcustomDatadescriptionidmodifiedAtnamestatustypevalue
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassignedEncodingIdassignedIngestPointIdcreatedAtcustomDatadescriptionidmodifiedAtnamestatustypevalue
\ No newline at end of file diff --git a/docs/classes/StreamKeyConfiguration.html b/docs/classes/StreamKeyConfiguration.html index 1adb2fd80..24ee04b08 100644 --- a/docs/classes/StreamKeyConfiguration.html +++ b/docs/classes/StreamKeyConfiguration.html @@ -1,8 +1,8 @@ StreamKeyConfiguration | @bitmovin/api-sdk

Class StreamKeyConfiguration

Export

StreamKeyConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

streamKeyId? type? -

Constructors

constructor

Properties

Optional streamKeyId

streamKeyId?: string

Id of the previously generated stream key. Only needed when the type is ASSIGN.

+

Constructors

constructor

Properties

Optional streamKeyId

streamKeyId?: string

Id of the previously generated stream key. Only needed when the type is ASSIGN.

Memberof

StreamKeyConfiguration

-

Optional type

type?: StreamKeyConfigurationType

Memberof

StreamKeyConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorstreamKeyIdtype
\ No newline at end of file +

Optional type

type?: StreamKeyConfigurationType

Memberof

StreamKeyConfiguration

+

Settings

Member Visibility

Theme

On This Page

constructorstreamKeyIdtype
\ No newline at end of file diff --git a/docs/classes/StreamKeysUnassignAction.html b/docs/classes/StreamKeysUnassignAction.html index 8190e35e7..adf27bf6e 100644 --- a/docs/classes/StreamKeysUnassignAction.html +++ b/docs/classes/StreamKeysUnassignAction.html @@ -1,6 +1,6 @@ StreamKeysUnassignAction | @bitmovin/api-sdk

Class StreamKeysUnassignAction

Export

StreamKeysUnassignAction

-

Constructors

constructor +

Constructors

constructor

Properties

encodingId? -

Constructors

constructor

Properties

Optional encodingId

encodingId?: string

Encoding ID for which stream keys should be unassigned

+

Constructors

constructor

Properties

Optional encodingId

encodingId?: string

Encoding ID for which stream keys should be unassigned

Memberof

StreamKeysUnassignAction

-

Settings

Member Visibility

Theme

On This Page

constructorencodingId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorencodingId
\ No newline at end of file diff --git a/docs/classes/StreamMetadata.html b/docs/classes/StreamMetadata.html index 111e86e4c..29db08653 100644 --- a/docs/classes/StreamMetadata.html +++ b/docs/classes/StreamMetadata.html @@ -1,6 +1,6 @@ StreamMetadata | @bitmovin/api-sdk

Class StreamMetadata

Export

StreamMetadata

-

Constructors

constructor +

Constructors

constructor

Properties

language? -

Constructors

constructor

Properties

Optional language

language?: string

Language of the media contained in the stream. If the value is not set, then no metadata tag is set for the media stream.

+

Constructors

constructor

Properties

Optional language

language?: string

Language of the media contained in the stream. If the value is not set, then no metadata tag is set for the media stream.

Memberof

StreamMetadata

-

Settings

Member Visibility

Theme

On This Page

constructorlanguage
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorlanguage
\ No newline at end of file diff --git a/docs/classes/StreamPerTitleFixedResolutionAndBitrateSettings.html b/docs/classes/StreamPerTitleFixedResolutionAndBitrateSettings.html index 87bd65ac6..8395429b5 100644 --- a/docs/classes/StreamPerTitleFixedResolutionAndBitrateSettings.html +++ b/docs/classes/StreamPerTitleFixedResolutionAndBitrateSettings.html @@ -1,18 +1,18 @@ StreamPerTitleFixedResolutionAndBitrateSettings | @bitmovin/api-sdk

Class StreamPerTitleFixedResolutionAndBitrateSettings

Export

StreamPerTitleFixedResolutionAndBitrateSettings

-

Constructors

constructor +

Constructors

constructor

Properties

bitrateSelectionMode? highComplexityBoundaryForMaxBitrate? lowComplexityBoundaryForMaxBitrate? maxBitrate? minBitrate? -

Constructors

constructor

Properties

Optional bitrateSelectionMode

bitrateSelectionMode?: BitrateSelectionMode

Bitrate selection mode

+

Constructors

constructor

Properties

Optional bitrateSelectionMode

bitrateSelectionMode?: BitrateSelectionMode

Bitrate selection mode

Memberof

StreamPerTitleFixedResolutionAndBitrateSettings

-

Optional highComplexityBoundaryForMaxBitrate

highComplexityBoundaryForMaxBitrate?: number

High complexity boundary for max bitrate

+

Optional highComplexityBoundaryForMaxBitrate

highComplexityBoundaryForMaxBitrate?: number

High complexity boundary for max bitrate

Memberof

StreamPerTitleFixedResolutionAndBitrateSettings

-

Optional lowComplexityBoundaryForMaxBitrate

lowComplexityBoundaryForMaxBitrate?: number

Low complexity boundary for max bitrate

+

Optional lowComplexityBoundaryForMaxBitrate

lowComplexityBoundaryForMaxBitrate?: number

Low complexity boundary for max bitrate

Memberof

StreamPerTitleFixedResolutionAndBitrateSettings

-

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used for that template.

+

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used for that template.

Memberof

StreamPerTitleFixedResolutionAndBitrateSettings

-

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used for that template.

+

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used for that template.

Memberof

StreamPerTitleFixedResolutionAndBitrateSettings

-

Settings

Member Visibility

Theme

On This Page

constructorbitrateSelectionModehighComplexityBoundaryForMaxBitratelowComplexityBoundaryForMaxBitratemaxBitrateminBitrate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbitrateSelectionModehighComplexityBoundaryForMaxBitratelowComplexityBoundaryForMaxBitratemaxBitrateminBitrate
\ No newline at end of file diff --git a/docs/classes/StreamPerTitleSettings.html b/docs/classes/StreamPerTitleSettings.html index 854fb0d32..9dc87867a 100644 --- a/docs/classes/StreamPerTitleSettings.html +++ b/docs/classes/StreamPerTitleSettings.html @@ -1,6 +1,6 @@ StreamPerTitleSettings | @bitmovin/api-sdk

Class StreamPerTitleSettings

Export

StreamPerTitleSettings

-

Constructors

constructor +

Constructors

constructor

Properties

fixedResolutionAndBitrateSettings? -

Constructors

constructor

Properties

Optional fixedResolutionAndBitrateSettings

fixedResolutionAndBitrateSettings?: StreamPerTitleFixedResolutionAndBitrateSettings

Settings for PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE mode

+

Constructors

constructor

Properties

Optional fixedResolutionAndBitrateSettings

fixedResolutionAndBitrateSettings?: StreamPerTitleFixedResolutionAndBitrateSettings

Settings for PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE mode

Memberof

StreamPerTitleSettings

-

Settings

Member Visibility

Theme

On This Page

constructorfixedResolutionAndBitrateSettings
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorfixedResolutionAndBitrateSettings
\ No newline at end of file diff --git a/docs/classes/StreamsAdConfigAd.html b/docs/classes/StreamsAdConfigAd.html index c924dbcdd..b13950ccb 100644 --- a/docs/classes/StreamsAdConfigAd.html +++ b/docs/classes/StreamsAdConfigAd.html @@ -1,9 +1,9 @@ StreamsAdConfigAd | @bitmovin/api-sdk

Class StreamsAdConfigAd

Export

StreamsAdConfigAd

-

Constructors

constructor +

Constructors

constructor

Properties

position? type? url? -

Constructors

constructor

Properties

Optional position

position?: string

Memberof

StreamsAdConfigAd

-

Optional type

type?: string

Memberof

StreamsAdConfigAd

-

Optional url

url?: string

Memberof

StreamsAdConfigAd

-

Settings

Member Visibility

Theme

On This Page

constructorpositiontypeurl
\ No newline at end of file +

Constructors

constructor

Properties

Optional position

position?: string

Memberof

StreamsAdConfigAd

+

Optional type

type?: string

Memberof

StreamsAdConfigAd

+

Optional url

url?: string

Memberof

StreamsAdConfigAd

+

Settings

Member Visibility

Theme

On This Page

constructorpositiontypeurl
\ No newline at end of file diff --git a/docs/classes/StreamsAdConfigResponse.html b/docs/classes/StreamsAdConfigResponse.html index 96af46f90..cc1a7c356 100644 --- a/docs/classes/StreamsAdConfigResponse.html +++ b/docs/classes/StreamsAdConfigResponse.html @@ -1,8 +1,8 @@ StreamsAdConfigResponse | @bitmovin/api-sdk

Class StreamsAdConfigResponse

Export

StreamsAdConfigResponse

-

Constructors

constructor +

Constructors

constructor

Properties

ads? id? -

Constructors

constructor

Properties

Optional ads

ads?: StreamsAdConfigAd[]

Memberof

StreamsAdConfigResponse

-

Optional id

id?: string

The identifier of the streams ad config

+

Constructors

constructor

Properties

Optional ads

ads?: StreamsAdConfigAd[]

Memberof

StreamsAdConfigResponse

+

Optional id

id?: string

The identifier of the streams ad config

Memberof

StreamsAdConfigResponse

-

Settings

Member Visibility

Theme

On This Page

constructoradsid
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoradsid
\ No newline at end of file diff --git a/docs/classes/StreamsDomainRestrictionCreateRequest.html b/docs/classes/StreamsDomainRestrictionCreateRequest.html index b5369e5ac..f19be3647 100644 --- a/docs/classes/StreamsDomainRestrictionCreateRequest.html +++ b/docs/classes/StreamsDomainRestrictionCreateRequest.html @@ -1,12 +1,12 @@ StreamsDomainRestrictionCreateRequest | @bitmovin/api-sdk

Class StreamsDomainRestrictionCreateRequest

Export

StreamsDomainRestrictionCreateRequest

-

Constructors

constructor +

Constructors

constructor

Properties

allowNoReferer? allowShare? allowedDomains? -

Constructors

constructor

Properties

Optional allowNoReferer

allowNoReferer?: boolean

Controls if requests to domain restricted streams without referer header should be allowed or denied

+

Constructors

constructor

Properties

Optional allowNoReferer

allowNoReferer?: boolean

Controls if requests to domain restricted streams without referer header should be allowed or denied

Memberof

StreamsDomainRestrictionCreateRequest

-

Optional allowShare

allowShare?: boolean

Controls if Stream is accessible via sharing URL or not

+

Optional allowShare

allowShare?: boolean

Controls if Stream is accessible via sharing URL or not

Memberof

StreamsDomainRestrictionCreateRequest

-

Optional allowedDomains

allowedDomains?: string[]

The list of allowed domains (required)

+

Optional allowedDomains

allowedDomains?: string[]

The list of allowed domains (required)

Memberof

StreamsDomainRestrictionCreateRequest

-

Settings

Member Visibility

Theme

On This Page

constructorallowNoRefererallowShareallowedDomains
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorallowNoRefererallowShareallowedDomains
\ No newline at end of file diff --git a/docs/classes/StreamsDomainRestrictionResponse.html b/docs/classes/StreamsDomainRestrictionResponse.html index 05cfb415b..8f577a9ba 100644 --- a/docs/classes/StreamsDomainRestrictionResponse.html +++ b/docs/classes/StreamsDomainRestrictionResponse.html @@ -1,15 +1,15 @@ StreamsDomainRestrictionResponse | @bitmovin/api-sdk

Class StreamsDomainRestrictionResponse

Export

StreamsDomainRestrictionResponse

-

Constructors

constructor +

Constructors

constructor

Properties

allowNoReferer? allowShare? allowedDomains? id? -

Constructors

constructor

Properties

Optional allowNoReferer

allowNoReferer?: boolean

Controls if requests to domain restricted streams without referer header should be allowed or denied

+

Constructors

constructor

Properties

Optional allowNoReferer

allowNoReferer?: boolean

Controls if requests to domain restricted streams without referer header should be allowed or denied

Memberof

StreamsDomainRestrictionResponse

-

Optional allowShare

allowShare?: boolean

Controls if Stream is accessible via sharing URL or not

+

Optional allowShare

allowShare?: boolean

Controls if Stream is accessible via sharing URL or not

Memberof

StreamsDomainRestrictionResponse

-

Optional allowedDomains

allowedDomains?: string[]

The list of allowed domains

+

Optional allowedDomains

allowedDomains?: string[]

The list of allowed domains

Memberof

StreamsDomainRestrictionResponse

-

Optional id

id?: string

The identifier of the streams domain restriction entity

+

Optional id

id?: string

The identifier of the streams domain restriction entity

Memberof

StreamsDomainRestrictionResponse

-

Settings

Member Visibility

Theme

On This Page

constructorallowNoRefererallowShareallowedDomainsid
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorallowNoRefererallowShareallowedDomainsid
\ No newline at end of file diff --git a/docs/classes/StreamsDomainRestrictionUpdateRequest.html b/docs/classes/StreamsDomainRestrictionUpdateRequest.html index 1b937ac99..3cd689618 100644 --- a/docs/classes/StreamsDomainRestrictionUpdateRequest.html +++ b/docs/classes/StreamsDomainRestrictionUpdateRequest.html @@ -1,12 +1,12 @@ StreamsDomainRestrictionUpdateRequest | @bitmovin/api-sdk

Class StreamsDomainRestrictionUpdateRequest

Export

StreamsDomainRestrictionUpdateRequest

-

Constructors

constructor +

Constructors

constructor

Properties

allowNoReferer? allowShare? allowedDomains? -

Constructors

constructor

Properties

Optional allowNoReferer

allowNoReferer?: boolean

Controls if requests to domain restricted streams without referer header should be allowed or denied

+

Constructors

constructor

Properties

Optional allowNoReferer

allowNoReferer?: boolean

Controls if requests to domain restricted streams without referer header should be allowed or denied

Memberof

StreamsDomainRestrictionUpdateRequest

-

Optional allowShare

allowShare?: boolean

Controls if Stream is accessible via sharing URL or not

+

Optional allowShare

allowShare?: boolean

Controls if Stream is accessible via sharing URL or not

Memberof

StreamsDomainRestrictionUpdateRequest

-

Optional allowedDomains

allowedDomains?: string[]

The list of allowed domains

+

Optional allowedDomains

allowedDomains?: string[]

The list of allowed domains

Memberof

StreamsDomainRestrictionUpdateRequest

-

Settings

Member Visibility

Theme

On This Page

constructorallowNoRefererallowShareallowedDomains
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorallowNoRefererallowShareallowedDomains
\ No newline at end of file diff --git a/docs/classes/StreamsLiveCreateRequest.html b/docs/classes/StreamsLiveCreateRequest.html index 16f9daeae..89cb5ef75 100644 --- a/docs/classes/StreamsLiveCreateRequest.html +++ b/docs/classes/StreamsLiveCreateRequest.html @@ -1,12 +1,12 @@ StreamsLiveCreateRequest | @bitmovin/api-sdk

Class StreamsLiveCreateRequest

Export

StreamsLiveCreateRequest

-

Constructors

constructor +

Constructors

constructor

Properties

description? domainRestrictionId? title? -

Constructors

constructor

Properties

Optional description

description?: string

Description of the stream

+

Constructors

constructor

Properties

Optional description

description?: string

Description of the stream

Memberof

StreamsLiveCreateRequest

-

Optional domainRestrictionId

domainRestrictionId?: string

Id of the domain restriction config to use

+

Optional domainRestrictionId

domainRestrictionId?: string

Id of the domain restriction config to use

Memberof

StreamsLiveCreateRequest

-

Optional title

title?: string

Title of the stream

+

Optional title

title?: string

Title of the stream

Memberof

StreamsLiveCreateRequest

-

Settings

Member Visibility

Theme

On This Page

constructordescriptiondomainRestrictionIdtitle
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordescriptiondomainRestrictionIdtitle
\ No newline at end of file diff --git a/docs/classes/StreamsLiveResponse.html b/docs/classes/StreamsLiveResponse.html index 3d5c18298..37d8a0065 100644 --- a/docs/classes/StreamsLiveResponse.html +++ b/docs/classes/StreamsLiveResponse.html @@ -1,5 +1,5 @@ StreamsLiveResponse | @bitmovin/api-sdk

Class StreamsLiveResponse

Export

StreamsLiveResponse

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

adConfig? createdAt? description? @@ -14,25 +14,25 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional adConfig

adConfig?: StreamsAdConfigResponse

Memberof

StreamsLiveResponse

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional adConfig

adConfig?: StreamsAdConfigResponse

Memberof

StreamsLiveResponse

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

StreamsResponse

-

Optional description

description?: string

The description of the stream

+

Optional description

description?: string

The description of the stream

Memberof

StreamsResponse

-

Optional domainRestriction

domainRestriction?: StreamsDomainRestrictionResponse

Memberof

StreamsLiveResponse

-

Optional id

id?: string

The identifier of the stream

+

Optional domainRestriction

domainRestriction?: StreamsDomainRestrictionResponse

Memberof

StreamsLiveResponse

+

Optional id

id?: string

The identifier of the stream

Memberof

StreamsResponse

-

Optional lifeCycle

lifeCycle?: StreamsLiveLifeCycle

The life cycle of the stream

+

Optional lifeCycle

lifeCycle?: StreamsLiveLifeCycle

The life cycle of the stream

Memberof

StreamsLiveResponse

-

Optional posterUrl

posterUrl?: string

Poster URL

+

Optional posterUrl

posterUrl?: string

Poster URL

Memberof

StreamsLiveResponse

-

Optional streamKey

streamKey?: string

The streamKey of the stream

+

Optional streamKey

streamKey?: string

The streamKey of the stream

Memberof

StreamsLiveResponse

-

Optional styleConfig

styleConfig?: StreamsStyleConfigResponse

Memberof

StreamsLiveResponse

-

Optional title

title?: string

The title of the stream

+

Optional styleConfig

styleConfig?: StreamsStyleConfigResponse

Memberof

StreamsLiveResponse

+

Optional title

title?: string

The title of the stream

Memberof

StreamsResponse

-

Optional trimming

trimming?: StreamsTrimmingStatus

Stream trimming information

+

Optional trimming

trimming?: StreamsTrimmingStatus

Stream trimming information

Memberof

StreamsLiveResponse

-

Readonly type

type: StreamsType = StreamsType.LIVE

Discriminator property for StreamsResponse

+

Readonly type

type: StreamsType = StreamsType.LIVE

Discriminator property for StreamsResponse

Memberof

StreamsLiveResponse

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    LIVE: string;
    VIDEO: string;
} = ...

Type declaration

  • LIVE: string
  • VIDEO: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradConfigcreatedAtdescriptiondomainRestrictionidlifeCycleposterUrlstreamKeystyleConfigtitletrimmingtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    LIVE: string;
    VIDEO: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradConfigcreatedAtdescriptiondomainRestrictionidlifeCycleposterUrlstreamKeystyleConfigtitletrimmingtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/StreamsLiveUpdateRequest.html b/docs/classes/StreamsLiveUpdateRequest.html index 646b1fc2e..3f2e43ff5 100644 --- a/docs/classes/StreamsLiveUpdateRequest.html +++ b/docs/classes/StreamsLiveUpdateRequest.html @@ -1,15 +1,15 @@ StreamsLiveUpdateRequest | @bitmovin/api-sdk

Class StreamsLiveUpdateRequest

Export

StreamsLiveUpdateRequest

-

Constructors

constructor +

Constructors

constructor

Properties

description? domainRestrictionId? posterUrl? title? -

Constructors

constructor

Properties

Optional description

description?: string

The new description of the stream

+

Constructors

constructor

Properties

Optional description

description?: string

The new description of the stream

Memberof

StreamsLiveUpdateRequest

-

Optional domainRestrictionId

domainRestrictionId?: string

Id of the domain restriction config to use

+

Optional domainRestrictionId

domainRestrictionId?: string

Id of the domain restriction config to use

Memberof

StreamsLiveUpdateRequest

-

Optional posterUrl

posterUrl?: string

URL to hosted poster image

+

Optional posterUrl

posterUrl?: string

URL to hosted poster image

Memberof

StreamsLiveUpdateRequest

-

Optional title

title?: string

The new title of the stream

+

Optional title

title?: string

The new title of the stream

Memberof

StreamsLiveUpdateRequest

-

Settings

Member Visibility

Theme

On This Page

constructordescriptiondomainRestrictionIdposterUrltitle
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordescriptiondomainRestrictionIdposterUrltitle
\ No newline at end of file diff --git a/docs/classes/StreamsPublicSigningKey.html b/docs/classes/StreamsPublicSigningKey.html index 299cea353..fab8929ad 100644 --- a/docs/classes/StreamsPublicSigningKey.html +++ b/docs/classes/StreamsPublicSigningKey.html @@ -1,8 +1,8 @@ StreamsPublicSigningKey | @bitmovin/api-sdk

Class StreamsPublicSigningKey

Export

StreamsPublicSigningKey

-

Constructors

constructor +

Constructors

constructor

Properties

createdAt? keyId? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Memberof

StreamsPublicSigningKey

-

Optional keyId

keyId?: string

The unique identifier of the key

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Memberof

StreamsPublicSigningKey

+

Optional keyId

keyId?: string

The unique identifier of the key

Memberof

StreamsPublicSigningKey

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtkeyId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtkeyId
\ No newline at end of file diff --git a/docs/classes/StreamsPublicSigningKeyResponse.html b/docs/classes/StreamsPublicSigningKeyResponse.html index fab8c3b32..6897ea4cf 100644 --- a/docs/classes/StreamsPublicSigningKeyResponse.html +++ b/docs/classes/StreamsPublicSigningKeyResponse.html @@ -1,5 +1,5 @@ StreamsPublicSigningKeyResponse | @bitmovin/api-sdk

Class StreamsPublicSigningKeyResponse

Export

StreamsPublicSigningKeyResponse

-

Constructors

constructor +

Constructors

constructor

Properties

publicKeys? -

Constructors

constructor

Properties

Optional publicKeys

publicKeys?: StreamsPublicSigningKey[]

Memberof

StreamsPublicSigningKeyResponse

-

Settings

Member Visibility

Theme

On This Page

constructorpublicKeys
\ No newline at end of file +

Constructors

constructor

Properties

Optional publicKeys

publicKeys?: StreamsPublicSigningKey[]

Memberof

StreamsPublicSigningKeyResponse

+

Settings

Member Visibility

Theme

On This Page

constructorpublicKeys
\ No newline at end of file diff --git a/docs/classes/StreamsResponse.html b/docs/classes/StreamsResponse.html index ffef11097..f51cedf11 100644 --- a/docs/classes/StreamsResponse.html +++ b/docs/classes/StreamsResponse.html @@ -1,5 +1,5 @@ StreamsResponse | @bitmovin/api-sdk

Class StreamsResponse

Export

StreamsResponse

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? description? id? @@ -7,14 +7,14 @@ type? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

StreamsResponse

-

Optional description

description?: string

The description of the stream

+

Optional description

description?: string

The description of the stream

Memberof

StreamsResponse

-

Optional id

id?: string

The identifier of the stream

+

Optional id

id?: string

The identifier of the stream

Memberof

StreamsResponse

-

Optional title

title?: string

The title of the stream

+

Optional title

title?: string

The title of the stream

Memberof

StreamsResponse

-

Optional type

type?: StreamsType

Type of the Stream contained in the StreamsResponse

+

Optional type

type?: StreamsType

Type of the Stream contained in the StreamsResponse

Memberof

StreamsResponse

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    LIVE: string;
    VIDEO: string;
} = ...

Type declaration

  • LIVE: string
  • VIDEO: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtdescriptionidtitletype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    LIVE: string;
    VIDEO: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtdescriptionidtitletype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/StreamsSigningKeyResponse.html b/docs/classes/StreamsSigningKeyResponse.html index e16167760..63c569ad9 100644 --- a/docs/classes/StreamsSigningKeyResponse.html +++ b/docs/classes/StreamsSigningKeyResponse.html @@ -1,11 +1,11 @@ StreamsSigningKeyResponse | @bitmovin/api-sdk

Class StreamsSigningKeyResponse

Export

StreamsSigningKeyResponse

-

Constructors

constructor +

Constructors

constructor

Properties

keyId? message? privateKey? -

Constructors

constructor

Properties

Optional keyId

keyId?: string

The unique identifier of the key

+

Constructors

constructor

Properties

Optional keyId

keyId?: string

The unique identifier of the key

Memberof

StreamsSigningKeyResponse

-

Optional message

message?: string

Memberof

StreamsSigningKeyResponse

-

Optional privateKey

privateKey?: string

base64-encoded PEM file of the private key

+

Optional message

message?: string

Memberof

StreamsSigningKeyResponse

+

Optional privateKey

privateKey?: string

base64-encoded PEM file of the private key

Memberof

StreamsSigningKeyResponse

-

Settings

Member Visibility

Theme

On This Page

constructorkeyIdmessageprivateKey
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorkeyIdmessageprivateKey
\ No newline at end of file diff --git a/docs/classes/StreamsStyleConfigPlayerStyle.html b/docs/classes/StreamsStyleConfigPlayerStyle.html index d2ad15a38..558013b61 100644 --- a/docs/classes/StreamsStyleConfigPlayerStyle.html +++ b/docs/classes/StreamsStyleConfigPlayerStyle.html @@ -1,6 +1,6 @@ StreamsStyleConfigPlayerStyle | @bitmovin/api-sdk

Class StreamsStyleConfigPlayerStyle

Player style config

Export

StreamsStyleConfigPlayerStyle

-

Constructors

constructor +

Constructors

constructor

Properties

backgroundColor? playbackMarkerBgColor? playbackMarkerBorderColor? @@ -8,18 +8,18 @@ playbackTrackBufferedColor? playbackTrackPlayedColor? textColor? -

Constructors

constructor

Properties

Optional backgroundColor

backgroundColor?: string

Background color

+

Constructors

constructor

Properties

Optional backgroundColor

backgroundColor?: string

Background color

Memberof

StreamsStyleConfigPlayerStyle

-

Optional playbackMarkerBgColor

playbackMarkerBgColor?: string

Playback marker background color

+

Optional playbackMarkerBgColor

playbackMarkerBgColor?: string

Playback marker background color

Memberof

StreamsStyleConfigPlayerStyle

-

Optional playbackMarkerBorderColor

playbackMarkerBorderColor?: string

Playback marker border color

+

Optional playbackMarkerBorderColor

playbackMarkerBorderColor?: string

Playback marker border color

Memberof

StreamsStyleConfigPlayerStyle

-

Optional playbackTrackBgColor

playbackTrackBgColor?: string

Playback track background color

+

Optional playbackTrackBgColor

playbackTrackBgColor?: string

Playback track background color

Memberof

StreamsStyleConfigPlayerStyle

-

Optional playbackTrackBufferedColor

playbackTrackBufferedColor?: string

Playback track buffered color

+

Optional playbackTrackBufferedColor

playbackTrackBufferedColor?: string

Playback track buffered color

Memberof

StreamsStyleConfigPlayerStyle

-

Optional playbackTrackPlayedColor

playbackTrackPlayedColor?: string

Playback track played color

+

Optional playbackTrackPlayedColor

playbackTrackPlayedColor?: string

Playback track played color

Memberof

StreamsStyleConfigPlayerStyle

-

Optional textColor

textColor?: string

Text color

+

Optional textColor

textColor?: string

Text color

Memberof

StreamsStyleConfigPlayerStyle

-

Settings

Member Visibility

Theme

On This Page

constructorbackgroundColorplaybackMarkerBgColorplaybackMarkerBorderColorplaybackTrackBgColorplaybackTrackBufferedColorplaybackTrackPlayedColortextColor
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbackgroundColorplaybackMarkerBgColorplaybackMarkerBorderColorplaybackTrackBgColorplaybackTrackBufferedColorplaybackTrackPlayedColortextColor
\ No newline at end of file diff --git a/docs/classes/StreamsStyleConfigResponse.html b/docs/classes/StreamsStyleConfigResponse.html index aaf1ecbc7..d7c23fbff 100644 --- a/docs/classes/StreamsStyleConfigResponse.html +++ b/docs/classes/StreamsStyleConfigResponse.html @@ -1,17 +1,17 @@ StreamsStyleConfigResponse | @bitmovin/api-sdk

Class StreamsStyleConfigResponse

Export

StreamsStyleConfigResponse

-

Constructors

constructor +

Constructors

constructor

Properties

id? orgId? playerStyle? watermarkTargetLink? watermarkUrl? -

Constructors

constructor

Properties

Optional id

id?: string

The identifier of the style config

+

Constructors

constructor

Properties

Optional id

id?: string

The identifier of the style config

Memberof

StreamsStyleConfigResponse

-

Optional orgId

orgId?: string

UUID of the associated organization

+

Optional orgId

orgId?: string

UUID of the associated organization

Memberof

StreamsStyleConfigResponse

-

Optional playerStyle

playerStyle?: StreamsStyleConfigPlayerStyle

Memberof

StreamsStyleConfigResponse

-

Optional watermarkTargetLink

watermarkTargetLink?: string

Target link of the watermark image

+

Optional playerStyle

playerStyle?: StreamsStyleConfigPlayerStyle

Memberof

StreamsStyleConfigResponse

+

Optional watermarkTargetLink

watermarkTargetLink?: string

Target link of the watermark image

Memberof

StreamsStyleConfigResponse

-

Optional watermarkUrl

watermarkUrl?: string

URL of the watermark image

+

Optional watermarkUrl

watermarkUrl?: string

URL of the watermark image

Memberof

StreamsStyleConfigResponse

-

Settings

Member Visibility

Theme

On This Page

constructoridorgIdplayerStylewatermarkTargetLinkwatermarkUrl
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridorgIdplayerStylewatermarkTargetLinkwatermarkUrl
\ No newline at end of file diff --git a/docs/classes/StreamsVideoCreateRequest.html b/docs/classes/StreamsVideoCreateRequest.html index 2908074d2..a68dbabee 100644 --- a/docs/classes/StreamsVideoCreateRequest.html +++ b/docs/classes/StreamsVideoCreateRequest.html @@ -1,21 +1,21 @@ StreamsVideoCreateRequest | @bitmovin/api-sdk

Class StreamsVideoCreateRequest

Export

StreamsVideoCreateRequest

-

Constructors

constructor +

Constructors

constructor

Properties

assetUrl? description? domainRestrictionId? encodingProfile? signed? title? -

Constructors

constructor

Properties

Optional assetUrl

assetUrl?: string

The streams input asset URL

+

Constructors

constructor

Properties

Optional assetUrl

assetUrl?: string

The streams input asset URL

Memberof

StreamsVideoCreateRequest

-

Optional description

description?: string

Description of the stream

+

Optional description

description?: string

Description of the stream

Memberof

StreamsVideoCreateRequest

-

Optional domainRestrictionId

domainRestrictionId?: string

Id of the domain restriction config to use

+

Optional domainRestrictionId

domainRestrictionId?: string

Id of the domain restriction config to use

Memberof

StreamsVideoCreateRequest

-

Optional encodingProfile

encodingProfile?: StreamsEncodingProfile

Profile to be used in encoding

+

Optional encodingProfile

encodingProfile?: StreamsEncodingProfile

Profile to be used in encoding

Memberof

StreamsVideoCreateRequest

-

Optional signed

signed?: boolean

If set to true the Stream is only accessible via a token

+

Optional signed

signed?: boolean

If set to true the Stream is only accessible via a token

Memberof

StreamsVideoCreateRequest

-

Optional title

title?: string

Title of the stream

+

Optional title

title?: string

Title of the stream

Memberof

StreamsVideoCreateRequest

-

Settings

Member Visibility

Theme

On This Page

constructorassetUrldescriptiondomainRestrictionIdencodingProfilesignedtitle
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassetUrldescriptiondomainRestrictionIdencodingProfilesignedtitle
\ No newline at end of file diff --git a/docs/classes/StreamsVideoEncodingTask.html b/docs/classes/StreamsVideoEncodingTask.html index 3f55726d7..b5848e901 100644 --- a/docs/classes/StreamsVideoEncodingTask.html +++ b/docs/classes/StreamsVideoEncodingTask.html @@ -1,9 +1,9 @@ StreamsVideoEncodingTask | @bitmovin/api-sdk

Class StreamsVideoEncodingTask

Export

StreamsVideoEncodingTask

-

Constructors

constructor +

Constructors

constructor

Properties

quality? status? -

Constructors

constructor

Properties

Optional quality

quality?: StreamsVideoQuality

Quality of the encoding

+

Constructors

constructor

Properties

Optional quality

quality?: StreamsVideoQuality

Quality of the encoding

Memberof

StreamsVideoEncodingTask

-

Optional status

status?: StreamsVideoEncodingStatus

Current state of the encoding

+

Optional status

status?: StreamsVideoEncodingStatus

Current state of the encoding

Memberof

StreamsVideoEncodingTask

-

Settings

Member Visibility

Theme

On This Page

constructorqualitystatus
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorqualitystatus
\ No newline at end of file diff --git a/docs/classes/StreamsVideoResponse.html b/docs/classes/StreamsVideoResponse.html index dd647e8d0..d6ed96ce8 100644 --- a/docs/classes/StreamsVideoResponse.html +++ b/docs/classes/StreamsVideoResponse.html @@ -1,5 +1,5 @@ StreamsVideoResponse | @bitmovin/api-sdk

Class StreamsVideoResponse

Export

StreamsVideoResponse

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

adConfig? assetUrl? createdAt? @@ -17,31 +17,31 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional adConfig

adConfig?: StreamsAdConfigResponse

Memberof

StreamsVideoResponse

-

Optional assetUrl

assetUrl?: string

The asset URL of the stream

+

Constructors

constructor

Properties

Optional adConfig

adConfig?: StreamsAdConfigResponse

Memberof

StreamsVideoResponse

+

Optional assetUrl

assetUrl?: string

The asset URL of the stream

Memberof

StreamsVideoResponse

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

StreamsResponse

-

Optional description

description?: string

The description of the stream

+

Optional description

description?: string

The description of the stream

Memberof

StreamsResponse

-

Optional domainRestriction

domainRestriction?: StreamsDomainRestrictionResponse

Memberof

StreamsVideoResponse

-

Optional downloadUrl

downloadUrl?: string

Single-file download URL of the unaltered video in the best available quality

+

Optional domainRestriction

domainRestriction?: StreamsDomainRestrictionResponse

Memberof

StreamsVideoResponse

+

Optional downloadUrl

downloadUrl?: string

Single-file download URL of the unaltered video in the best available quality

Memberof

StreamsVideoResponse

-

Optional encodingTasks

encodingTasks?: StreamsVideoEncodingTask[]

List of encoding status information

+

Optional encodingTasks

encodingTasks?: StreamsVideoEncodingTask[]

List of encoding status information

Memberof

StreamsVideoResponse

-

Optional id

id?: string

The identifier of the stream

+

Optional id

id?: string

The identifier of the stream

Memberof

StreamsResponse

-

Optional posterUrl

posterUrl?: string

Poster URL

+

Optional posterUrl

posterUrl?: string

Poster URL

Memberof

StreamsVideoResponse

-

Optional signed

signed?: boolean

True if the stream is signature protected

+

Optional signed

signed?: boolean

True if the stream is signature protected

Memberof

StreamsVideoResponse

-

Optional status

status?: StreamsVideoStatus

The status of the stream

+

Optional status

status?: StreamsVideoStatus

The status of the stream

Memberof

StreamsVideoResponse

-

Optional styleConfig

styleConfig?: StreamsStyleConfigResponse

Memberof

StreamsVideoResponse

-

Optional title

title?: string

The title of the stream

+

Optional styleConfig

styleConfig?: StreamsStyleConfigResponse

Memberof

StreamsVideoResponse

+

Optional title

title?: string

The title of the stream

Memberof

StreamsResponse

-

Optional trimming

trimming?: StreamsTrimmingStatus

Stream trimming information

+

Optional trimming

trimming?: StreamsTrimmingStatus

Stream trimming information

Memberof

StreamsVideoResponse

-

Readonly type

type: StreamsType = StreamsType.VIDEO

Discriminator property for StreamsResponse

+

Readonly type

type: StreamsType = StreamsType.VIDEO

Discriminator property for StreamsResponse

Memberof

StreamsVideoResponse

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    LIVE: string;
    VIDEO: string;
} = ...

Type declaration

  • LIVE: string
  • VIDEO: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradConfigassetUrlcreatedAtdescriptiondomainRestrictiondownloadUrlencodingTasksidposterUrlsignedstatusstyleConfigtitletrimmingtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    LIVE: string;
    VIDEO: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoradConfigassetUrlcreatedAtdescriptiondomainRestrictiondownloadUrlencodingTasksidposterUrlsignedstatusstyleConfigtitletrimmingtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/StreamsVideoUpdateRequest.html b/docs/classes/StreamsVideoUpdateRequest.html index 2beb87428..151d71822 100644 --- a/docs/classes/StreamsVideoUpdateRequest.html +++ b/docs/classes/StreamsVideoUpdateRequest.html @@ -1,18 +1,18 @@ StreamsVideoUpdateRequest | @bitmovin/api-sdk

Class StreamsVideoUpdateRequest

Export

StreamsVideoUpdateRequest

-

Constructors

constructor +

Constructors

constructor

Properties

description? domainRestrictionId? posterUrl? status? title? -

Constructors

constructor

Properties

Optional description

description?: string

The new description of the stream

+

Constructors

constructor

Properties

Optional description

description?: string

The new description of the stream

Memberof

StreamsVideoUpdateRequest

-

Optional domainRestrictionId

domainRestrictionId?: string

Id of the domain restriction config to use

+

Optional domainRestrictionId

domainRestrictionId?: string

Id of the domain restriction config to use

Memberof

StreamsVideoUpdateRequest

-

Optional posterUrl

posterUrl?: string

URL to hosted poster image

+

Optional posterUrl

posterUrl?: string

URL to hosted poster image

Memberof

StreamsVideoUpdateRequest

-

Optional status

status?: StreamsVideoStatus

The new status of the stream

+

Optional status

status?: StreamsVideoStatus

The new status of the stream

Memberof

StreamsVideoUpdateRequest

-

Optional title

title?: string

The new title of the stream

+

Optional title

title?: string

The new title of the stream

Memberof

StreamsVideoUpdateRequest

-

Settings

Member Visibility

Theme

On This Page

constructordescriptiondomainRestrictionIdposterUrlstatustitle
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordescriptiondomainRestrictionIdposterUrlstatustitle
\ No newline at end of file diff --git a/docs/classes/Subtask.html b/docs/classes/Subtask.html index fbb00d750..15cc9b312 100644 --- a/docs/classes/Subtask.html +++ b/docs/classes/Subtask.html @@ -1,5 +1,5 @@ Subtask | @bitmovin/api-sdk

Class Subtask

Export

Subtask

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? errorAt? finishedAt? @@ -12,28 +12,28 @@ startedAt? status? updatedAt? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Timestamp when the subtask was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Timestamp when the subtask was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Subtask

-

Optional errorAt

errorAt?: Date

Timestamp when the subtask status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an 'ERROR'.

+

Optional errorAt

errorAt?: Date

Timestamp when the subtask status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an 'ERROR'.

Memberof

Subtask

-

Optional finishedAt

finishedAt?: Date

Timestamp when the subtask status changed to a final state like 'FINISHED', 'ERROR', 'CANCELED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for subtasks which ran prior to the 1.50.0 REST API release.

+

Optional finishedAt

finishedAt?: Date

Timestamp when the subtask status changed to a final state like 'FINISHED', 'ERROR', 'CANCELED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for subtasks which ran prior to the 1.50.0 REST API release.

Memberof

Subtask

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional messages

messages?: Message[]

Task specific messages

+

Optional messages

messages?: Message[]

Task specific messages

Memberof

Subtask

-

Optional name

name?: string

Name of the subtask (required)

+

Optional name

name?: string

Name of the subtask (required)

Memberof

Subtask

-

Optional progress

progress?: number

Progress in percent

+

Optional progress

progress?: number

Progress in percent

Memberof

Subtask

-

Optional queuedAt

queuedAt?: Date

Timestamp when the subtask status changed to 'QUEUED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional queuedAt

queuedAt?: Date

Timestamp when the subtask status changed to 'QUEUED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Subtask

-

Optional runningAt

runningAt?: Date

Timestamp when the subtask status changed to 'RUNNING', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional runningAt

runningAt?: Date

Timestamp when the subtask status changed to 'RUNNING', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Subtask

-

Optional startedAt

startedAt?: Date

Timestamp when the subtask was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional startedAt

startedAt?: Date

Timestamp when the subtask was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Subtask

-

Optional status

status?: Status

Current status (required)

+

Optional status

status?: Status

Current status (required)

Memberof

Subtask

-

Optional updatedAt

updatedAt?: Date

Timestamp when the subtask was last updated, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional updatedAt

updatedAt?: Date

Timestamp when the subtask was last updated, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Subtask

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAterrorAtfinishedAtidmessagesnameprogressqueuedAtrunningAtstartedAtstatusupdatedAt
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAterrorAtfinishedAtidmessagesnameprogressqueuedAtrunningAtstartedAtstatusupdatedAt
\ No newline at end of file diff --git a/docs/classes/SubtitleAdaptationSet.html b/docs/classes/SubtitleAdaptationSet.html index f68311cc1..ff4aaa381 100644 --- a/docs/classes/SubtitleAdaptationSet.html +++ b/docs/classes/SubtitleAdaptationSet.html @@ -1,5 +1,5 @@ SubtitleAdaptationSet | @bitmovin/api-sdk

Class SubtitleAdaptationSet

Export

SubtitleAdaptationSet

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessibilities? customAttributes? id? @@ -9,18 +9,18 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

+

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

Memberof

AdaptationSet

-

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

+

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

Memberof

AdaptationSet

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional labels

labels?: Label[]

List of labels

+

Optional labels

labels?: Label[]

List of labels

Memberof

AdaptationSet

-

Optional lang

lang?: string

ISO 639-1 (Alpha-2) code identifying the language of the subtitle adaptation set (required)

+

Optional lang

lang?: string

ISO 639-1 (Alpha-2) code identifying the language of the subtitle adaptation set (required)

Memberof

SubtitleAdaptationSet

-

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

+

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

Memberof

AdaptationSet

-

Readonly type

type: AdaptationSetType = AdaptationSetType.SUBTITLE

Discriminator property for AdaptationSet

+

Readonly type

type: AdaptationSetType = AdaptationSetType.SUBTITLE

Discriminator property for AdaptationSet

Memberof

SubtitleAdaptationSet

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

  • AUDIO: string
  • IMAGE: string
  • SUBTITLE: string
  • VIDEO: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelslangrolestype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelslangrolestype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SubtitleConfiguration.html b/docs/classes/SubtitleConfiguration.html index e43f94a30..067428a8a 100644 --- a/docs/classes/SubtitleConfiguration.html +++ b/docs/classes/SubtitleConfiguration.html @@ -1,5 +1,5 @@ SubtitleConfiguration | @bitmovin/api-sdk

Class SubtitleConfiguration

Export

SubtitleConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -8,16 +8,16 @@ name? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidmodifiedAtname_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/SubtitleStream.html b/docs/classes/SubtitleStream.html index b569f5378..548bc6eed 100644 --- a/docs/classes/SubtitleStream.html +++ b/docs/classes/SubtitleStream.html @@ -1,21 +1,21 @@ SubtitleStream | @bitmovin/api-sdk

Class SubtitleStream

Export

SubtitleStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

codec? duration? hearingImpaired? id? language? position? -

Constructors

constructor

Properties

Optional codec

codec?: string

Codec of the stream

+

Constructors

constructor

Properties

Optional codec

codec?: string

Codec of the stream

Memberof

MediaStream

-

Optional duration

duration?: number

Duration of the stream in seconds

+

Optional duration

duration?: number

Duration of the stream in seconds

Memberof

MediaStream

-

Optional hearingImpaired

hearingImpaired?: boolean

Hearing impaired support

+

Optional hearingImpaired

hearingImpaired?: boolean

Hearing impaired support

Memberof

SubtitleStream

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional language

language?: string

Language of the stream

+

Optional language

language?: string

Language of the stream

Memberof

SubtitleStream

-

Optional position

position?: number

Position of the stream in the media, starting from 0.

+

Optional position

position?: number

Position of the stream in the media, starting from 0.

Memberof

MediaStream

-

Settings

Member Visibility

Theme

On This Page

constructorcodecdurationhearingImpairedidlanguageposition
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcodecdurationhearingImpairedidlanguageposition
\ No newline at end of file diff --git a/docs/classes/SubtitlesMediaInfo.html b/docs/classes/SubtitlesMediaInfo.html index 3a6a4f82a..8d4c2c0de 100644 --- a/docs/classes/SubtitlesMediaInfo.html +++ b/docs/classes/SubtitlesMediaInfo.html @@ -1,5 +1,5 @@ SubtitlesMediaInfo | @bitmovin/api-sdk

Class SubtitlesMediaInfo

Export

SubtitlesMediaInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assocLanguage? autoselect? characteristics? @@ -17,38 +17,38 @@ startSegmentNumber? streamId? uri? -

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

+

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

Memberof

BasicMediaInfo

-

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

+

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

Memberof

BasicMediaInfo

-

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

+

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

Memberof

BasicMediaInfo

-

Optional drmId

drmId?: string

Id of the DRM.

+

Optional drmId

drmId?: string

Id of the DRM.

Memberof

SegmentsMediaInfo

-

Optional encodingId

encodingId?: string

Id of the encoding. (required)

+

Optional encodingId

encodingId?: string

Id of the encoding. (required)

Memberof

SegmentsMediaInfo

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

Memberof

SegmentsMediaInfo

-

Optional forced

forced?: boolean

A value of true indicates that the Rendition contains content which is considered essential to play.

+

Optional forced

forced?: boolean

A value of true indicates that the Rendition contains content which is considered essential to play.

Memberof

SubtitlesMediaInfo

-

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

+

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

Memberof

BasicMediaInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

+

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

Memberof

BasicMediaInfo

-

Optional language

language?: string

Primary language in the rendition.

+

Optional language

language?: string

Primary language in the rendition.

Memberof

BasicMediaInfo

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

SegmentsMediaInfo

-

Optional name

name?: string

Human readable description of the rendition. (required)

+

Optional name

name?: string

Human readable description of the rendition. (required)

Memberof

BasicMediaInfo

-

Optional segmentPath

segmentPath?: string

Path to segments. (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. (required)

Memberof

SegmentsMediaInfo

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

Memberof

SegmentsMediaInfo

-

Optional streamId

streamId?: string

Id of the stream. (required)

+

Optional streamId

streamId?: string

Id of the stream. (required)

Memberof

SegmentsMediaInfo

-

Optional uri

uri?: string

The URI of the Rendition (required)

+

Optional uri

uri?: string

The URI of the Rendition (required)

Memberof

StandardMediaInfo

-

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumberforcedgroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamIduri
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumberforcedgroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamIduri
\ No newline at end of file diff --git a/docs/classes/Task.html b/docs/classes/Task.html index 1b727c1a1..218a80502 100644 --- a/docs/classes/Task.html +++ b/docs/classes/Task.html @@ -1,5 +1,5 @@ Task | @bitmovin/api-sdk

Class Task

Export

Task

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? error? errorAt? @@ -12,28 +12,28 @@ runningAt? status? subtasks? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Timestamp when the task was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Timestamp when the task was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Task

-

Optional error

error?: ErrorDetails

Additional optional error details

+

Optional error

error?: ErrorDetails

Additional optional error details

Memberof

Task

-

Optional errorAt

errorAt?: Date

Timestamp when the subtask status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an 'ERROR'.

+

Optional errorAt

errorAt?: Date

Timestamp when the subtask status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an 'ERROR'.

Memberof

Task

-

Optional eta

eta?: number

Estimated ETA in seconds

+

Optional eta

eta?: number

Estimated ETA in seconds

Memberof

Task

-

Optional finishedAt

finishedAt?: Date

Timestamp when the subtask status changed to a final state like 'FINISHED', 'ERROR', 'CANCELED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for tasks which ran prior to the 1.50.0 REST API release.

+

Optional finishedAt

finishedAt?: Date

Timestamp when the subtask status changed to a final state like 'FINISHED', 'ERROR', 'CANCELED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for tasks which ran prior to the 1.50.0 REST API release.

Memberof

Task

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional messages

messages?: Message[]

Task specific messages

+

Optional messages

messages?: Message[]

Task specific messages

Memberof

Task

-

Optional progress

progress?: number

Progress in percent

+

Optional progress

progress?: number

Progress in percent

Memberof

Task

-

Optional queuedAt

queuedAt?: Date

Timestamp when the task status changed to "QUEUED", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional queuedAt

queuedAt?: Date

Timestamp when the task status changed to "QUEUED", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Task

-

Optional runningAt

runningAt?: Date

Timestamp when the task status changed to "RUNNING", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional runningAt

runningAt?: Date

Timestamp when the task status changed to "RUNNING", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

Task

-

Optional status

status?: Status

Current status (required)

+

Optional status

status?: Status

Current status (required)

Memberof

Task

-

Optional subtasks

subtasks?: Subtask[]

List of subtasks

+

Optional subtasks

subtasks?: Subtask[]

List of subtasks

Memberof

Task

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAterrorerrorAtetafinishedAtidmessagesprogressqueuedAtrunningAtstatussubtasks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAterrorerrorAtetafinishedAtidmessagesprogressqueuedAtrunningAtstatussubtasks
\ No newline at end of file diff --git a/docs/classes/Tenant.html b/docs/classes/Tenant.html index 27c790519..3a976c420 100644 --- a/docs/classes/Tenant.html +++ b/docs/classes/Tenant.html @@ -1,5 +1,5 @@ Tenant | @bitmovin/api-sdk

Class Tenant

Export

Tenant

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -7,18 +7,18 @@ id? modifiedAt? name? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional eMail

eMail?: string

Email address of the tenant. (required)

+

Optional eMail

eMail?: string

Email address of the tenant. (required)

Memberof

Tenant

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptioneMailidmodifiedAtname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptioneMailidmodifiedAtname
\ No newline at end of file diff --git a/docs/classes/TenantGroupDetail.html b/docs/classes/TenantGroupDetail.html index 7e0a91702..430930263 100644 --- a/docs/classes/TenantGroupDetail.html +++ b/docs/classes/TenantGroupDetail.html @@ -1,9 +1,9 @@ TenantGroupDetail | @bitmovin/api-sdk

Class TenantGroupDetail

Export

TenantGroupDetail

-

Constructors

constructor +

Constructors

constructor

Properties

id? name? -

Constructors

constructor

Properties

Optional id

id?: string

Id of Group

+

Constructors

constructor

Properties

Optional id

id?: string

Id of Group

Memberof

TenantGroupDetail

-

Optional name

name?: string

Name of Group

+

Optional name

name?: string

Name of Group

Memberof

TenantGroupDetail

-

Settings

Member Visibility

Theme

On This Page

constructoridname
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridname
\ No newline at end of file diff --git a/docs/classes/TenantWithGroups.html b/docs/classes/TenantWithGroups.html index 97332d3b7..cb184a515 100644 --- a/docs/classes/TenantWithGroups.html +++ b/docs/classes/TenantWithGroups.html @@ -1,12 +1,12 @@ TenantWithGroups | @bitmovin/api-sdk

Class TenantWithGroups

Export

TenantWithGroups

-

Constructors

constructor +

Constructors

constructor

Properties

email? groups? id? -

Constructors

constructor

Properties

Optional email

email?: string

Email of Tenant (required)

+

Constructors

constructor

Properties

Optional email

email?: string

Email of Tenant (required)

Memberof

TenantWithGroups

-

Optional groups

groups?: TenantGroupDetail[]

List of all groups of Tenant (required)

+

Optional groups

groups?: TenantGroupDetail[]

List of all groups of Tenant (required)

Memberof

TenantWithGroups

-

Optional id

id?: string

Id of Tenant (required)

+

Optional id

id?: string

Id of Tenant (required)

Memberof

TenantWithGroups

-

Settings

Member Visibility

Theme

On This Page

constructoremailgroupsid
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoremailgroupsid
\ No newline at end of file diff --git a/docs/classes/TextFilter.html b/docs/classes/TextFilter.html index b0a2c6c30..90d10536f 100644 --- a/docs/classes/TextFilter.html +++ b/docs/classes/TextFilter.html @@ -1,6 +1,6 @@ TextFilter | @bitmovin/api-sdk

Class TextFilter

Only one of those properties may be set: fontSize, fontSizeExpression.

Export

TextFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

alpha? borderWidth? box? @@ -29,55 +29,55 @@ y? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional alpha

alpha?: number

If set, alpha blending for the text is applied. Values are valid between 0.0 and 1.0.

+

Constructors

constructor

Properties

Optional alpha

alpha?: number

If set, alpha blending for the text is applied. Values are valid between 0.0 and 1.0.

Memberof

TextFilter

-

Optional borderWidth

borderWidth?: number

Width of the border around the text

+

Optional borderWidth

borderWidth?: number

Width of the border around the text

Memberof

TextFilter

-

Optional box

box?: boolean

If set to true a box is drawn around the text using the background color.

+

Optional box

box?: boolean

If set to true a box is drawn around the text using the background color.

Memberof

TextFilter

-

Optional boxBorderWidth

boxBorderWidth?: number

The width of the box drawn around the text.

+

Optional boxBorderWidth

boxBorderWidth?: number

The width of the box drawn around the text.

Memberof

TextFilter

-

Optional boxColor

boxColor?: string

The background color to be used for drawing the box.

+

Optional boxColor

boxColor?: string

The background color to be used for drawing the box.

Memberof

TextFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional fixBounds

fixBounds?: boolean

If set to true, it will fix text coordinates to avoid clipping if necessary

+

Optional fixBounds

fixBounds?: boolean

If set to true, it will fix text coordinates to avoid clipping if necessary

Memberof

TextFilter

-

Optional font

font?: TextFilterFont

Memberof

TextFilter

-

Optional fontColor

fontColor?: string

The color to be used to draw the text

+

Optional font

font?: TextFilterFont

Memberof

TextFilter

+

Optional fontColor

fontColor?: string

The color to be used to draw the text

Memberof

TextFilter

-

Optional fontSize

fontSize?: number

Font size to be used to draw the text

+

Optional fontSize

fontSize?: number

Font size to be used to draw the text

Memberof

TextFilter

-

Optional fontSizeExpression

fontSizeExpression?: string

An expression for the Font size. Either fontSize or fontSizeExpression can be set at the same time. The following variables are valid: main_h, h, H for input height and main_w, w, W for the input_width

+

Optional fontSizeExpression

fontSizeExpression?: string

An expression for the Font size. Either fontSize or fontSizeExpression can be set at the same time. The following variables are valid: main_h, h, H for input height and main_w, w, W for the input_width

Memberof

TextFilter

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional lineSpacing

lineSpacing?: number

Line spacing of the border around the box in pixels

+

Optional lineSpacing

lineSpacing?: number

Line spacing of the border around the box in pixels

Memberof

TextFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: string

Video frame rate

+

Optional rate

rate?: string

Video frame rate

Memberof

TextFilter

-

Optional shadowColor

shadowColor?: string

Color of the shadow

+

Optional shadowColor

shadowColor?: string

Color of the shadow

Memberof

TextFilter

-

Optional shadowX

shadowX?: number

X offset of the shadow

+

Optional shadowX

shadowX?: number

X offset of the shadow

Memberof

TextFilter

-

Optional shadowY

shadowY?: number

Y offset of the shadow

+

Optional shadowY

shadowY?: number

Y offset of the shadow

Memberof

TextFilter

-

Optional text

text?: string

String to be drawn

+

Optional text

text?: string

String to be drawn

Memberof

TextFilter

-

Optional timecode

timecode?: string

If set, the timecode representation in "hh:mm:ss[:;.]ff" format will be applied. Drop-frame timecodes (containing ";" or ".") must only be used with video frame rates of 29.97, 30, 59.94 or 60 FPS, according to the SMPTE standard

+

Optional timecode

timecode?: string

If set, the timecode representation in "hh:mm:ss[:;.]ff" format will be applied. Drop-frame timecodes (containing ";" or ".") must only be used with video frame rates of 29.97, 30, 59.94 or 60 FPS, according to the SMPTE standard

Memberof

TextFilter

-

Readonly type

type: FilterType = FilterType.TEXT

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.TEXT

Discriminator property for Filter

Memberof

TextFilter

-

Optional x

x?: string

X position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width (required)

+

Optional x

x?: string

X position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width (required)

Memberof

TextFilter

-

Optional y

y?: string

Y position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width (required)

+

Optional y

y?: string

Y position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width (required)

Memberof

TextFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoralphaborderWidthboxboxBorderWidthboxColorcreatedAtcustomDatadescriptionfixBoundsfontfontColorfontSizefontSizeExpressionidlineSpacingmodifiedAtnamerateshadowColorshadowXshadowYtexttimecodetypexy_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoralphaborderWidthboxboxBorderWidthboxColorcreatedAtcustomDatadescriptionfixBoundsfontfontColorfontSizefontSizeExpressionidlineSpacingmodifiedAtnamerateshadowColorshadowXshadowYtexttimecodetypexy_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/TextMuxing.html b/docs/classes/TextMuxing.html index 20fb11c78..18de08f20 100644 --- a/docs/classes/TextMuxing.html +++ b/docs/classes/TextMuxing.html @@ -1,5 +1,5 @@ TextMuxing | @bitmovin/api-sdk

Class TextMuxing

Export

TextMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -18,34 +18,34 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional filename

filename?: string

Name of the output file (required)

+

Optional filename

filename?: string

Name of the output file (required)

Memberof

TextMuxing

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. This only affects streams with WebVttConfiguration. If set, the X-TIMESTAMP-MAP will be added as described in the HLS specification. For example, if set to 10 seconds, X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000 will be added after each WEBVTT header. The default for TextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for startOffset for TsMuxings and ProgressiveTsMuxings is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same startOffset.

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. This only affects streams with WebVttConfiguration. If set, the X-TIMESTAMP-MAP will be added as described in the HLS specification. For example, if set to 10 seconds, X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000 will be added after each WEBVTT header. The default for TextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for startOffset for TsMuxings and ProgressiveTsMuxings is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same startOffset.

Memberof

TextMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.TEXT

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.TEXT

Discriminator property for Muxing

Memberof

TextMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Thumbnail.html b/docs/classes/Thumbnail.html index 35450ec78..8988a6180 100644 --- a/docs/classes/Thumbnail.html +++ b/docs/classes/Thumbnail.html @@ -1,5 +1,5 @@ Thumbnail | @bitmovin/api-sdk

Class Thumbnail

Export

Thumbnail

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

aspectMode? createdAt? customData? @@ -14,31 +14,31 @@ positions? unit? width? -

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: ThumbnailAspectMode

Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.

+

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: ThumbnailAspectMode

Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.

Memberof

Thumbnail

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional height

height?: number

Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.

+

Optional height

height?: number

Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.

Memberof

Thumbnail

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional interval

interval?: number

The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.

+

Optional interval

interval?: number

The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.

Memberof

Thumbnail

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Thumbnail

-

Optional pattern

pattern?: string

Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s). (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Thumbnail

+

Optional pattern

pattern?: string

Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s). (required)

Memberof

Thumbnail

-

Optional positions

positions?: number[]

Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.

+

Optional positions

positions?: number[]

Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.

Memberof

Thumbnail

-

Optional unit

unit?: ThumbnailUnit

Unit of the values in the positions array.

+

Optional unit

unit?: ThumbnailUnit

Unit of the values in the positions array.

Memberof

Thumbnail

-

Optional width

width?: number

Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported

+

Optional width

width?: number

Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported

Memberof

Thumbnail

-

Settings

Member Visibility

Theme

On This Page

constructoraspectModecreatedAtcustomDatadescriptionheightidintervalmodifiedAtnameoutputspatternpositionsunitwidth
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraspectModecreatedAtcustomDatadescriptionheightidintervalmodifiedAtnameoutputspatternpositionsunitwidth
\ No newline at end of file diff --git a/docs/classes/TimeBasedTrimmingInputStream.html b/docs/classes/TimeBasedTrimmingInputStream.html index d7d8c3451..44522ea62 100644 --- a/docs/classes/TimeBasedTrimmingInputStream.html +++ b/docs/classes/TimeBasedTrimmingInputStream.html @@ -1,5 +1,5 @@ TimeBasedTrimmingInputStream | @bitmovin/api-sdk

Class TimeBasedTrimmingInputStream

Export

TimeBasedTrimmingInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional duration

duration?: number

Defines how many seconds of the input will be encoded. Not defining or setting it to null indicates that the remaining input (considering offset) will be encoded.

+

Optional duration

duration?: number

Defines how many seconds of the input will be encoded. Not defining or setting it to null indicates that the remaining input (considering offset) will be encoded.

Memberof

TimeBasedTrimmingInputStream

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputStreamId

inputStreamId?: string

The id of the ingest input stream that should be trimmed

+

Optional inputStreamId

inputStreamId?: string

The id of the ingest input stream that should be trimmed

Memberof

TimeBasedTrimmingInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional offset

offset?: number

Defines the offset in seconds at which the encoding should start, beginning at 0. The frame indicated by this value will be included in the encoding

+

Optional offset

offset?: number

Defines the offset in seconds at which the encoding should start, beginning at 0. The frame indicated by this value will be included in the encoding

Memberof

TimeBasedTrimmingInputStream

-

Readonly type

type: InputStreamType = InputStreamType.TRIMMING_TIME_BASED

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.TRIMMING_TIME_BASED

Discriminator property for InputStream

Memberof

TimeBasedTrimmingInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptiondurationidinputStreamIdmodifiedAtnameoffsettype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptiondurationidinputStreamIdmodifiedAtnameoffsettype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/TimeCode.html b/docs/classes/TimeCode.html index 2860e0b7e..0b6acc3ba 100644 --- a/docs/classes/TimeCode.html +++ b/docs/classes/TimeCode.html @@ -1,6 +1,6 @@ TimeCode | @bitmovin/api-sdk

Class TimeCode

Export

TimeCode

-

Constructors

constructor +

Constructors

constructor

Properties

timeCodeStart? -

Constructors

constructor

Properties

Optional timeCodeStart

timeCodeStart?: string

Specify start timecode for writing.

+

Constructors

constructor

Properties

Optional timeCodeStart

timeCodeStart?: string

Specify start timecode for writing.

Memberof

TimeCode

-

Settings

Member Visibility

Theme

On This Page

constructortimeCodeStart
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructortimeCodeStart
\ No newline at end of file diff --git a/docs/classes/TimeSpan.html b/docs/classes/TimeSpan.html index 7e44b3f04..5f4c842cb 100644 --- a/docs/classes/TimeSpan.html +++ b/docs/classes/TimeSpan.html @@ -1,9 +1,9 @@ TimeSpan | @bitmovin/api-sdk

Class TimeSpan

Export

TimeSpan

-

Constructors

constructor +

Constructors

constructor

Properties

from? to? -

Constructors

constructor

Properties

Optional from

from?: number

Start offset of the time frame in milliseconds (required)

+

Constructors

constructor

Properties

Optional from

from?: number

Start offset of the time frame in milliseconds (required)

Memberof

TimeSpan

-

Optional to

to?: number

End offset of the time frame in milliseconds (required)

+

Optional to

to?: number

End offset of the time frame in milliseconds (required)

Memberof

TimeSpan

-

Settings

Member Visibility

Theme

On This Page

constructorfromto
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorfromto
\ No newline at end of file diff --git a/docs/classes/TimecodeTrackTrimmingInputStream.html b/docs/classes/TimecodeTrackTrimmingInputStream.html index 425b28498..a2bab0e25 100644 --- a/docs/classes/TimecodeTrackTrimmingInputStream.html +++ b/docs/classes/TimecodeTrackTrimmingInputStream.html @@ -1,5 +1,5 @@ TimecodeTrackTrimmingInputStream | @bitmovin/api-sdk

Class TimecodeTrackTrimmingInputStream

Export

TimecodeTrackTrimmingInputStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional endTimeCode

endTimeCode?: string

Defines the timecode, in SMPTE-12M format, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding (required)

+

Optional endTimeCode

endTimeCode?: string

Defines the timecode, in SMPTE-12M format, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding (required)

Memberof

TimecodeTrackTrimmingInputStream

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputStreamId

inputStreamId?: string

The id of the ingest input stream that should be trimmed (required)

+

Optional inputStreamId

inputStreamId?: string

The id of the ingest input stream that should be trimmed (required)

Memberof

TimecodeTrackTrimmingInputStream

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional startTimeCode

startTimeCode?: string

Defines the timecode, in SMPTE-12M format, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding (required)

+

Optional startTimeCode

startTimeCode?: string

Defines the timecode, in SMPTE-12M format, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding (required)

Memberof

TimecodeTrackTrimmingInputStream

-

Readonly type

type: InputStreamType = InputStreamType.TRIMMING_TIME_CODE_TRACK

Discriminator property for InputStream

+

Readonly type

type: InputStreamType = InputStreamType.TRIMMING_TIME_CODE_TRACK

Discriminator property for InputStream

Memberof

TimecodeTrackTrimmingInputStream

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • CAPTION_CEA608: string
  • CAPTION_CEA708: string
  • CONCATENATION: string
  • DOLBY_ATMOS: string
  • DOLBY_VISION: string
  • DVB_SUBTITLE: string
  • FILE: string
  • INGEST: string
  • SIDECAR_DOLBY_VISION_METADATA: string
  • TRIMMING_H264_PICTURE_TIMING: string
  • TRIMMING_TIME_BASED: string
  • TRIMMING_TIME_CODE_TRACK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionendTimeCodeidinputStreamIdmodifiedAtnamestartTimeCodetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    CAPTION_CEA608: string;
    CAPTION_CEA708: string;
    CONCATENATION: string;
    DOLBY_ATMOS: string;
    DOLBY_VISION: string;
    DVB_SUBTITLE: string;
    FILE: string;
    INGEST: string;
    SIDECAR_DOLBY_VISION_METADATA: string;
    TRIMMING_H264_PICTURE_TIMING: string;
    TRIMMING_TIME_BASED: string;
    TRIMMING_TIME_CODE_TRACK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionendTimeCodeidinputStreamIdmodifiedAtnamestartTimeCodetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/TransferRetry.html b/docs/classes/TransferRetry.html index fef146c3b..7af2ef5cd 100644 --- a/docs/classes/TransferRetry.html +++ b/docs/classes/TransferRetry.html @@ -1,5 +1,5 @@ TransferRetry | @bitmovin/api-sdk

Class TransferRetry

Export

TransferRetry

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -10,24 +10,24 @@ name? startedAt? status? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional errorAt

errorAt?: Date

Timestamp when the transfer-retry status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional errorAt

errorAt?: Date

Timestamp when the transfer-retry status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

TransferRetry

-

Optional finishedAt

finishedAt?: Date

Timestamp when the transfer-retry status changed to 'FINISHED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional finishedAt

finishedAt?: Date

Timestamp when the transfer-retry status changed to 'FINISHED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

TransferRetry

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional startedAt

startedAt?: Date

Timestamp when the transfer-retry was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional startedAt

startedAt?: Date

Timestamp when the transfer-retry was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

TransferRetry

-

Optional status

status?: Status

The current status of the transfer-retry.

+

Optional status

status?: Status

The current status of the transfer-retry.

Memberof

TransferRetry

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionerrorAtfinishedAtidmodifiedAtnamestartedAtstatus
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionerrorAtfinishedAtidmodifiedAtnamestartedAtstatus
\ No newline at end of file diff --git a/docs/classes/Trimming.html b/docs/classes/Trimming.html index 5f325b9a8..fdacf07d6 100644 --- a/docs/classes/Trimming.html +++ b/docs/classes/Trimming.html @@ -1,18 +1,18 @@ Trimming | @bitmovin/api-sdk

Class Trimming

Export

Trimming

-

Constructors

constructor +

Constructors

constructor

Properties

duration? endPicTiming? ignoreDurationIfInputTooShort? offset? startPicTiming? -

Constructors

constructor

Properties

Optional duration

duration?: number

Defines how many seconds from the input will be encoded. If not set, the input will be encoded until its end.

+

Constructors

constructor

Properties

Optional duration

duration?: number

Defines how many seconds from the input will be encoded. If not set, the input will be encoded until its end.

Memberof

Trimming

-

Optional endPicTiming

endPicTiming?: string

Defines the H264 picture timing of the last frame, that will be included in the encoding. Any defined offset or duration in seconds will be ignored.

+

Optional endPicTiming

endPicTiming?: string

Defines the H264 picture timing of the last frame, that will be included in the encoding. Any defined offset or duration in seconds will be ignored.

Memberof

Trimming

-

Optional ignoreDurationIfInputTooShort

ignoreDurationIfInputTooShort?: boolean

When true, "duration" will be interpreted as a maximum and not cause an error if the input is too short

+

Optional ignoreDurationIfInputTooShort

ignoreDurationIfInputTooShort?: boolean

When true, "duration" will be interpreted as a maximum and not cause an error if the input is too short

Memberof

Trimming

-

Optional offset

offset?: number

Defines the offset in seconds from which the encoding should start, beginning at 0.

+

Optional offset

offset?: number

Defines the offset in seconds from which the encoding should start, beginning at 0.

Memberof

Trimming

-

Optional startPicTiming

startPicTiming?: string

Defines the H264 picture timing of the first frame from which the encoding should start. Any defined offset or duration in seconds will be ignored.

+

Optional startPicTiming

startPicTiming?: string

Defines the H264 picture timing of the first frame from which the encoding should start. Any defined offset or duration in seconds will be ignored.

Memberof

Trimming

-

Settings

Member Visibility

Theme

On This Page

constructordurationendPicTimingignoreDurationIfInputTooShortoffsetstartPicTiming
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordurationendPicTimingignoreDurationIfInputTooShortoffsetstartPicTiming
\ No newline at end of file diff --git a/docs/classes/TsAudioStreamConfiguration.html b/docs/classes/TsAudioStreamConfiguration.html index eccff8543..59dfa70be 100644 --- a/docs/classes/TsAudioStreamConfiguration.html +++ b/docs/classes/TsAudioStreamConfiguration.html @@ -1,9 +1,9 @@ TsAudioStreamConfiguration | @bitmovin/api-sdk

Class TsAudioStreamConfiguration

Export

TsAudioStreamConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

pid? streamId? -

Constructors

constructor

Properties

Optional pid

pid?: number

An integer value. MPEG Transport Stream Packet Identifier (PID) for this stream. (required)

+

Constructors

constructor

Properties

Optional pid

pid?: number

An integer value. MPEG Transport Stream Packet Identifier (PID) for this stream. (required)

Memberof

TsStreamConfiguration

-

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing. (required)

+

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing. (required)

Memberof

TsStreamConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorpidstreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpidstreamId
\ No newline at end of file diff --git a/docs/classes/TsMuxing.html b/docs/classes/TsMuxing.html index 8d42629c7..10a18afcd 100644 --- a/docs/classes/TsMuxing.html +++ b/docs/classes/TsMuxing.html @@ -1,5 +1,5 @@ TsMuxing | @bitmovin/api-sdk

Class TsMuxing

Export

TsMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? configuration? createdAt? @@ -22,42 +22,42 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional configuration

configuration?: TsMuxingConfiguration

Advanced Configuration of the MPEG Transport Stream Parameters

+

Optional configuration

configuration?: TsMuxingConfiguration

Advanced Configuration of the MPEG Transport Stream Parameters

Memberof

TsMuxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds

Memberof

TsMuxing

-

Optional segmentNaming

segmentNaming?: string

Segment naming policy

+

Optional segmentNaming

segmentNaming?: string

Segment naming policy

Memberof

TsMuxing

-

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

+

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

Memberof

TsMuxing

-

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

+

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

Memberof

TsMuxing

-

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).

+

Optional startOffset

startOffset?: number

Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).

Memberof

TsMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.TS

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.TS

Discriminator property for Muxing

Memberof

TsMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitrateconfigurationcreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitrateconfigurationcreatedAtcustomDatadescriptionidignoredBymaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/TsMuxingConfiguration.html b/docs/classes/TsMuxingConfiguration.html index 4cb022f76..1d33c1e5c 100644 --- a/docs/classes/TsMuxingConfiguration.html +++ b/docs/classes/TsMuxingConfiguration.html @@ -1,14 +1,14 @@ TsMuxingConfiguration | @bitmovin/api-sdk

Class TsMuxingConfiguration

Export

TsMuxingConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

audioStreams? pcr? pmt? programNumber? videoStreams? -

Constructors

constructor

Properties

Optional audioStreams

audioStreams?: TsAudioStreamConfiguration[]

Memberof

TsMuxingConfiguration

-

Optional pcr

pcr?: TsProgramClockReferenceConfiguration

Memberof

TsMuxingConfiguration

-

Optional pmt

pmt?: TsProgramMapTableConfiguration

Memberof

TsMuxingConfiguration

-

Optional programNumber

programNumber?: number

An integer value. Value for program_number field in the MPEG Transport Stream Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.

+

Constructors

constructor

Properties

Optional audioStreams

audioStreams?: TsAudioStreamConfiguration[]

Memberof

TsMuxingConfiguration

+

Optional pcr

pcr?: TsProgramClockReferenceConfiguration

Memberof

TsMuxingConfiguration

+

Optional pmt

pmt?: TsProgramMapTableConfiguration

Memberof

TsMuxingConfiguration

+

Optional programNumber

programNumber?: number

An integer value. Value for program_number field in the MPEG Transport Stream Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.

Memberof

TsMuxingConfiguration

-

Optional videoStreams

videoStreams?: TsVideoStreamConfiguration[]

Memberof

TsMuxingConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructoraudioStreamspcrpmtprogramNumbervideoStreams
\ No newline at end of file +

Optional videoStreams

videoStreams?: TsVideoStreamConfiguration[]

Memberof

TsMuxingConfiguration

+

Settings

Member Visibility

Theme

On This Page

constructoraudioStreamspcrpmtprogramNumbervideoStreams
\ No newline at end of file diff --git a/docs/classes/TsProgramClockReferenceConfiguration.html b/docs/classes/TsProgramClockReferenceConfiguration.html index a61382da6..1b6635baf 100644 --- a/docs/classes/TsProgramClockReferenceConfiguration.html +++ b/docs/classes/TsProgramClockReferenceConfiguration.html @@ -1,9 +1,9 @@ TsProgramClockReferenceConfiguration | @bitmovin/api-sdk

Class TsProgramClockReferenceConfiguration

Export

TsProgramClockReferenceConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

interval? pid? -

Constructors

constructor

Properties

Optional interval

interval?: number

An integer value. Nominal time between MPEG Transport Stream PCRs in milliseconds.

+

Constructors

constructor

Properties

Optional interval

interval?: number

An integer value. Nominal time between MPEG Transport Stream PCRs in milliseconds.

Memberof

TsProgramClockReferenceConfiguration

-

Optional pid

pid?: number

An integer value. Packet Identifier (PID) for the MPEG Transport Stream PCR. This should generally point to the video stream PID. If it is not explicitly set it will point to the video stream PID if exists, otherwise to the audio stream PID.

+

Optional pid

pid?: number

An integer value. Packet Identifier (PID) for the MPEG Transport Stream PCR. This should generally point to the video stream PID. If it is not explicitly set it will point to the video stream PID if exists, otherwise to the audio stream PID.

Memberof

TsProgramClockReferenceConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorintervalpid
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorintervalpid
\ No newline at end of file diff --git a/docs/classes/TsProgramMapTableConfiguration.html b/docs/classes/TsProgramMapTableConfiguration.html index 8591868b5..af333f138 100644 --- a/docs/classes/TsProgramMapTableConfiguration.html +++ b/docs/classes/TsProgramMapTableConfiguration.html @@ -1,6 +1,6 @@ TsProgramMapTableConfiguration | @bitmovin/api-sdk

Class TsProgramMapTableConfiguration

Export

TsProgramMapTableConfiguration

-

Constructors

constructor +

Constructors

constructor

Properties

pid? -

Constructors

constructor

Properties

Optional pid

pid?: number

An integer value. Packet Identifier (PID) for the MPEG Transport Stream PMT.

+

Constructors

constructor

Properties

Optional pid

pid?: number

An integer value. Packet Identifier (PID) for the MPEG Transport Stream PMT.

Memberof

TsProgramMapTableConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorpid
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpid
\ No newline at end of file diff --git a/docs/classes/TsStreamConfiguration.html b/docs/classes/TsStreamConfiguration.html index 8633c41bf..293b58605 100644 --- a/docs/classes/TsStreamConfiguration.html +++ b/docs/classes/TsStreamConfiguration.html @@ -1,9 +1,9 @@ TsStreamConfiguration | @bitmovin/api-sdk

Class TsStreamConfiguration

Export

TsStreamConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

pid? streamId? -

Constructors

constructor

Properties

Optional pid

pid?: number

An integer value. MPEG Transport Stream Packet Identifier (PID) for this stream. (required)

+

Constructors

constructor

Properties

Optional pid

pid?: number

An integer value. MPEG Transport Stream Packet Identifier (PID) for this stream. (required)

Memberof

TsStreamConfiguration

-

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing. (required)

+

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing. (required)

Memberof

TsStreamConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorpidstreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpidstreamId
\ No newline at end of file diff --git a/docs/classes/TsVideoStreamConfiguration.html b/docs/classes/TsVideoStreamConfiguration.html index 05fbde285..9f79a95d6 100644 --- a/docs/classes/TsVideoStreamConfiguration.html +++ b/docs/classes/TsVideoStreamConfiguration.html @@ -1,9 +1,9 @@ TsVideoStreamConfiguration | @bitmovin/api-sdk

Class TsVideoStreamConfiguration

Export

TsVideoStreamConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

pid? streamId? -

Constructors

constructor

Properties

Optional pid

pid?: number

An integer value. MPEG Transport Stream Packet Identifier (PID) for this stream. (required)

+

Constructors

constructor

Properties

Optional pid

pid?: number

An integer value. MPEG Transport Stream Packet Identifier (PID) for this stream. (required)

Memberof

TsStreamConfiguration

-

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing. (required)

+

Optional streamId

streamId?: string

The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing. (required)

Memberof

TsStreamConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorpidstreamId
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpidstreamId
\ No newline at end of file diff --git a/docs/classes/Tweaks.html b/docs/classes/Tweaks.html index 0830215c1..32b2cd426 100644 --- a/docs/classes/Tweaks.html +++ b/docs/classes/Tweaks.html @@ -1,6 +1,6 @@ Tweaks | @bitmovin/api-sdk

Class Tweaks

Export

Tweaks

-

Constructors

constructor +

Constructors

constructor

Properties

audioVideoSyncMode? -

Constructors

constructor

Properties

Optional audioVideoSyncMode

audioVideoSyncMode?: AudioVideoSyncMode

Different modes for syncing the start and end of audio input streams with the video inputs. This feature does not work with Dolby Digital (Plus) or Dolby Atmos.

+

Constructors

constructor

Properties

Optional audioVideoSyncMode

audioVideoSyncMode?: AudioVideoSyncMode

Different modes for syncing the start and end of audio input streams with the video inputs. This feature does not work with Dolby Digital (Plus) or Dolby Atmos.

Memberof

Tweaks

-

Settings

Member Visibility

Theme

On This Page

constructoraudioVideoSyncMode
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraudioVideoSyncMode
\ No newline at end of file diff --git a/docs/classes/UnsharpFilter.html b/docs/classes/UnsharpFilter.html index 0305ed5b2..b3cec28f4 100644 --- a/docs/classes/UnsharpFilter.html +++ b/docs/classes/UnsharpFilter.html @@ -1,5 +1,5 @@ UnsharpFilter | @bitmovin/api-sdk

Class UnsharpFilter

Export

UnsharpFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

chromaEffectStrength? chromaMatrixHorizontalSize? chromaMatrixVerticalSize? @@ -15,30 +15,30 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional chromaEffectStrength

chromaEffectStrength?: number

Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5

+

Constructors

constructor

Properties

Optional chromaEffectStrength

chromaEffectStrength?: number

Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5

Memberof

UnsharpFilter

-

Optional chromaMatrixHorizontalSize

chromaMatrixHorizontalSize?: number

Must be an odd integer between 3 and 23

+

Optional chromaMatrixHorizontalSize

chromaMatrixHorizontalSize?: number

Must be an odd integer between 3 and 23

Memberof

UnsharpFilter

-

Optional chromaMatrixVerticalSize

chromaMatrixVerticalSize?: number

Must be an odd integer between 3 and 23

+

Optional chromaMatrixVerticalSize

chromaMatrixVerticalSize?: number

Must be an odd integer between 3 and 23

Memberof

UnsharpFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional lumaEffectStrength

lumaEffectStrength?: number

Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5

+

Optional lumaEffectStrength

lumaEffectStrength?: number

Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5

Memberof

UnsharpFilter

-

Optional lumaMatrixHorizontalSize

lumaMatrixHorizontalSize?: number

Must be an odd integer between 3 and 23

+

Optional lumaMatrixHorizontalSize

lumaMatrixHorizontalSize?: number

Must be an odd integer between 3 and 23

Memberof

UnsharpFilter

-

Optional lumaMatrixVerticalSize

lumaMatrixVerticalSize?: number

Must be an odd integer between 3 and 23

+

Optional lumaMatrixVerticalSize

lumaMatrixVerticalSize?: number

Must be an odd integer between 3 and 23

Memberof

UnsharpFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Readonly type

type: FilterType = FilterType.UNSHARP

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.UNSHARP

Discriminator property for Filter

Memberof

UnsharpFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorchromaEffectStrengthchromaMatrixHorizontalSizechromaMatrixVerticalSizecreatedAtcustomDatadescriptionidlumaEffectStrengthlumaMatrixHorizontalSizelumaMatrixVerticalSizemodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorchromaEffectStrengthchromaMatrixHorizontalSizechromaMatrixVerticalSizecreatedAtcustomDatadescriptionidlumaEffectStrengthlumaMatrixHorizontalSizelumaMatrixVerticalSizemodifiedAtnametype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/UpdateOrganizationRequest.html b/docs/classes/UpdateOrganizationRequest.html index cff3bd522..0145fc919 100644 --- a/docs/classes/UpdateOrganizationRequest.html +++ b/docs/classes/UpdateOrganizationRequest.html @@ -1,10 +1,10 @@ UpdateOrganizationRequest | @bitmovin/api-sdk

Class UpdateOrganizationRequest

Export

UpdateOrganizationRequest

-

Constructors

constructor +

Constructors

constructor

Properties

description? labelColor? name? -

Constructors

constructor

Properties

Optional description

description?: string

Memberof

UpdateOrganizationRequest

-

Optional labelColor

labelColor?: string

Hexadecimal color

+

Constructors

constructor

Properties

Optional description

description?: string

Memberof

UpdateOrganizationRequest

+

Optional labelColor

labelColor?: string

Hexadecimal color

Memberof

UpdateOrganizationRequest

-

Optional name

name?: string

Memberof

UpdateOrganizationRequest

-

Settings

Member Visibility

Theme

On This Page

constructordescriptionlabelColorname
\ No newline at end of file +

Optional name

name?: string

Memberof

UpdateOrganizationRequest

+

Settings

Member Visibility

Theme

On This Page

constructordescriptionlabelColorname
\ No newline at end of file diff --git a/docs/classes/UtcTiming.html b/docs/classes/UtcTiming.html index 03977a4f9..60037d450 100644 --- a/docs/classes/UtcTiming.html +++ b/docs/classes/UtcTiming.html @@ -1,9 +1,9 @@ UtcTiming | @bitmovin/api-sdk

Class UtcTiming

Export

UtcTiming

-

Constructors

constructor +

Constructors

constructor

Properties

schemeIdUri? value? -

Constructors

constructor

Properties

Optional schemeIdUri

schemeIdUri?: string

The scheme id to use. Please refer to the DASH standard. (required)

+

Constructors

constructor

Properties

Optional schemeIdUri

schemeIdUri?: string

The scheme id to use. Please refer to the DASH standard. (required)

Memberof

UtcTiming

-

Optional value

value?: string

The server to get the time from (required)

+

Optional value

value?: string

The server to get the time from (required)

Memberof

UtcTiming

-

Settings

Member Visibility

Theme

On This Page

constructorschemeIdUrivalue
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorschemeIdUrivalue
\ No newline at end of file diff --git a/docs/classes/VideoAdaptationSet.html b/docs/classes/VideoAdaptationSet.html index 4d74d83b8..859ce8e52 100644 --- a/docs/classes/VideoAdaptationSet.html +++ b/docs/classes/VideoAdaptationSet.html @@ -1,5 +1,5 @@ VideoAdaptationSet | @bitmovin/api-sdk

Class VideoAdaptationSet

Export

VideoAdaptationSet

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

accessibilities? customAttributes? id? @@ -8,16 +8,16 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

+

Constructors

constructor

Properties

Optional accessibilities

accessibilities?: Accessibility[]

Provide signaling of CEA 607 and CEA 708

Memberof

AdaptationSet

-

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

+

Optional customAttributes

customAttributes?: CustomAttribute[]

Custom adaptation set attributes

Memberof

AdaptationSet

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional labels

labels?: Label[]

List of labels

+

Optional labels

labels?: Label[]

List of labels

Memberof

AdaptationSet

-

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

+

Optional roles

roles?: AdaptationSetRole[]

Roles of the adaptation set

Memberof

AdaptationSet

-

Readonly type

type: AdaptationSetType = AdaptationSetType.VIDEO

Discriminator property for AdaptationSet

+

Readonly type

type: AdaptationSetType = AdaptationSetType.VIDEO

Discriminator property for AdaptationSet

Memberof

VideoAdaptationSet

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

  • AUDIO: string
  • IMAGE: string
  • SUBTITLE: string
  • VIDEO: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelsrolestype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO: string;
    IMAGE: string;
    SUBTITLE: string;
    VIDEO: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraccessibilitiescustomAttributesidlabelsrolestype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/VideoConfiguration.html b/docs/classes/VideoConfiguration.html index cd835ac7f..392c0d590 100644 --- a/docs/classes/VideoConfiguration.html +++ b/docs/classes/VideoConfiguration.html @@ -1,5 +1,5 @@ VideoConfiguration | @bitmovin/api-sdk

Class VideoConfiguration

Export

VideoConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? colorConfig? createdAt? @@ -18,35 +18,35 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Memberof

VideoConfiguration

-

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

+

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Memberof

VideoConfiguration

-

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

+

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

Memberof

VideoConfiguration

-

Optional height

height?: number

Height of the encoded video in pixels

+

Optional height

height?: number

Height of the encoded video in pixels

Memberof

VideoConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

+

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Memberof

VideoConfiguration

-

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

+

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

Memberof

VideoConfiguration

-

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional width

width?: number

Width of the encoded video in pixels

+

Optional width

width?: number

Width of the encoded video in pixels

Memberof

VideoConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecolorConfigcreatedAtcustomDatadescriptiondisplayAspectRatioencodingModeheightidmodifiedAtnamepixelFormatratesampleAspectRatioDenominatorsampleAspectRatioNumeratorwidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecolorConfigcreatedAtcustomDatadescriptiondisplayAspectRatioencodingModeheightidmodifiedAtnamepixelFormatratesampleAspectRatioDenominatorsampleAspectRatioNumeratorwidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/VideoMediaInfo.html b/docs/classes/VideoMediaInfo.html index 7ab778a5b..a4add3108 100644 --- a/docs/classes/VideoMediaInfo.html +++ b/docs/classes/VideoMediaInfo.html @@ -1,5 +1,5 @@ VideoMediaInfo | @bitmovin/api-sdk

Class VideoMediaInfo

Export

VideoMediaInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assocLanguage? autoselect? characteristics? @@ -16,36 +16,36 @@ startSegmentNumber? streamId? uri? -

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

+

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

Memberof

BasicMediaInfo

-

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

+

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

Memberof

BasicMediaInfo

-

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

+

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

Memberof

BasicMediaInfo

-

Optional drmId

drmId?: string

Id of the DRM.

+

Optional drmId

drmId?: string

Id of the DRM.

Memberof

SegmentsMediaInfo

-

Optional encodingId

encodingId?: string

Id of the encoding. (required)

+

Optional encodingId

encodingId?: string

Id of the encoding. (required)

Memberof

SegmentsMediaInfo

-

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

+

Optional endSegmentNumber

endSegmentNumber?: number

Number of the last segment. Default is the last one that was encoded.

Memberof

SegmentsMediaInfo

-

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

+

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

Memberof

BasicMediaInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

+

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

Memberof

BasicMediaInfo

-

Optional language

language?: string

Primary language in the rendition.

+

Optional language

language?: string

Primary language in the rendition.

Memberof

BasicMediaInfo

-

Optional muxingId

muxingId?: string

Id of the muxing. (required)

+

Optional muxingId

muxingId?: string

Id of the muxing. (required)

Memberof

SegmentsMediaInfo

-

Optional name

name?: string

Human readable description of the rendition. (required)

+

Optional name

name?: string

Human readable description of the rendition. (required)

Memberof

BasicMediaInfo

-

Optional segmentPath

segmentPath?: string

Path to segments. (required)

+

Optional segmentPath

segmentPath?: string

Path to segments. (required)

Memberof

SegmentsMediaInfo

-

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

+

Optional startSegmentNumber

startSegmentNumber?: number

Number of the first segment. Default is 0.

Memberof

SegmentsMediaInfo

-

Optional streamId

streamId?: string

Id of the stream. (required)

+

Optional streamId

streamId?: string

Id of the stream. (required)

Memberof

SegmentsMediaInfo

-

Optional uri

uri?: string

The URI of the Rendition (required)

+

Optional uri

uri?: string

The URI of the Rendition (required)

Memberof

StandardMediaInfo

-

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumbergroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamIduri
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsdrmIdencodingIdendSegmentNumbergroupIdidisDefaultlanguagemuxingIdnamesegmentPathstartSegmentNumberstreamIduri
\ No newline at end of file diff --git a/docs/classes/VideoStream.html b/docs/classes/VideoStream.html index 616a96915..1b6c4d487 100644 --- a/docs/classes/VideoStream.html +++ b/docs/classes/VideoStream.html @@ -1,5 +1,5 @@ VideoStream | @bitmovin/api-sdk

Class VideoStream

Export

VideoStream

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? codec? duration? @@ -11,26 +11,26 @@ rate? rotation? width? -

Constructors

constructor

Properties

Optional bitrate

bitrate?: string

Bitrate in bps

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: string

Bitrate in bps

Memberof

VideoStream

-

Optional codec

codec?: string

Codec of the stream

+

Optional codec

codec?: string

Codec of the stream

Memberof

MediaStream

-

Optional duration

duration?: number

Duration of the stream in seconds

+

Optional duration

duration?: number

Duration of the stream in seconds

Memberof

MediaStream

-

Optional fps

fps?: string

Frame rate of the video

+

Optional fps

fps?: string

Frame rate of the video

Memberof

VideoStream

-

Optional height

height?: number

Height of the video (required)

+

Optional height

height?: number

Height of the video (required)

Memberof

VideoStream

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional par

par?: number

Pixel aspect ratio of the video. Default is 1.0

+

Optional par

par?: number

Pixel aspect ratio of the video. Default is 1.0

Memberof

VideoStream

-

Optional position

position?: number

Position of the stream in the media, starting from 0.

+

Optional position

position?: number

Position of the stream in the media, starting from 0.

Memberof

MediaStream

-

Optional rate

rate?: number

Bitrate in bps (the same as bitrate, but represented as an integer value)

+

Optional rate

rate?: number

Bitrate in bps (the same as bitrate, but represented as an integer value)

Memberof

VideoStream

-

Optional rotation

rotation?: number

Rotation of the video for mobile devices. Default is 0.

+

Optional rotation

rotation?: number

Rotation of the video for mobile devices. Default is 0.

Memberof

VideoStream

-

Optional width

width?: number

Width of the video (required)

+

Optional width

width?: number

Width of the video (required)

Memberof

VideoStream

-

Settings

Member Visibility

Theme

On This Page

constructorbitratecodecdurationfpsheightidparpositionraterotationwidth
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbitratecodecdurationfpsheightidparpositionraterotationwidth
\ No newline at end of file diff --git a/docs/classes/VorbisAudioConfiguration.html b/docs/classes/VorbisAudioConfiguration.html index 1d3215997..41f69ecdd 100644 --- a/docs/classes/VorbisAudioConfiguration.html +++ b/docs/classes/VorbisAudioConfiguration.html @@ -1,5 +1,5 @@ VorbisAudioConfiguration | @bitmovin/api-sdk

Class VorbisAudioConfiguration

Export

VorbisAudioConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? channelLayout? createdAt? @@ -12,24 +12,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

+

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded audio in bps (required)

Memberof

AudioConfiguration

-

Optional channelLayout

channelLayout?: VorbisChannelLayout

Channel layout of the audio codec configuration

+

Optional channelLayout

channelLayout?: VorbisChannelLayout

Channel layout of the audio codec configuration

Memberof

VorbisAudioConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional rate

rate?: number

Audio sampling rate in Hz

+

Optional rate

rate?: number

Audio sampling rate in Hz

Memberof

AudioConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.VORBIS

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.VORBIS

Discriminator property for CodecConfiguration

Memberof

VorbisAudioConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratechannelLayoutcreatedAtcustomDatadescriptionidmodifiedAtnameratetype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Vp8VideoConfiguration.html b/docs/classes/Vp8VideoConfiguration.html index a1d4d1c4e..5e31c6c1c 100644 --- a/docs/classes/Vp8VideoConfiguration.html +++ b/docs/classes/Vp8VideoConfiguration.html @@ -1,5 +1,5 @@ Vp8VideoConfiguration | @bitmovin/api-sdk

Class Vp8VideoConfiguration

Export

Vp8VideoConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

arnrMaxFrames? arnrStrength? arnrType? @@ -38,71 +38,71 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional arnrMaxFrames

arnrMaxFrames?: number

altref noise reduction max frame count.

+

Constructors

constructor

Properties

Optional arnrMaxFrames

arnrMaxFrames?: number

altref noise reduction max frame count.

Memberof

Vp8VideoConfiguration

-

Optional arnrStrength

arnrStrength?: number

altref noise reduction filter strength.

+

Optional arnrStrength

arnrStrength?: number

altref noise reduction filter strength.

Memberof

Vp8VideoConfiguration

-

Optional arnrType

arnrType?: Vp8ArnrType

Memberof

Vp8VideoConfiguration

-

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

+

Optional arnrType

arnrType?: Vp8ArnrType

Memberof

Vp8VideoConfiguration

+

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Memberof

VideoConfiguration

-

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

-

Optional cpuUsed

cpuUsed?: number

Memberof

Vp8VideoConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

+

Optional cpuUsed

cpuUsed?: number

Memberof

Vp8VideoConfiguration

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

+

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

Memberof

Vp8VideoConfiguration

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

+

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Memberof

VideoConfiguration

-

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

+

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

Memberof

VideoConfiguration

-

Optional height

height?: number

Height of the encoded video in pixels

+

Optional height

height?: number

Height of the encoded video in pixels

Memberof

VideoConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional lagInFrames

lagInFrames?: number

Number of frames to look ahead for alternate reference frame selection.

+

Optional lagInFrames

lagInFrames?: number

Number of frames to look ahead for alternate reference frame selection.

Memberof

Vp8VideoConfiguration

-

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

+

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

Memberof

Vp8VideoConfiguration

-

Optional maxIntraRate

maxIntraRate?: number

Maximum I-frame bitrate (percentage) 0=unlimited

+

Optional maxIntraRate

maxIntraRate?: number

Maximum I-frame bitrate (percentage) 0=unlimited

Memberof

Vp8VideoConfiguration

-

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

+

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

Memberof

Vp8VideoConfiguration

-

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames.

+

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames.

Memberof

Vp8VideoConfiguration

-

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

+

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

Memberof

Vp8VideoConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional noiseSensitivity

noiseSensitivity?: Vp8NoiseSensitivity

Memberof

Vp8VideoConfiguration

-

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

+

Optional noiseSensitivity

noiseSensitivity?: Vp8NoiseSensitivity

Memberof

Vp8VideoConfiguration

+

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Memberof

VideoConfiguration

-

Optional qpMax

qpMax?: number

Maximum quantization factor.

+

Optional qpMax

qpMax?: number

Maximum quantization factor.

Memberof

Vp8VideoConfiguration

-

Optional qpMin

qpMin?: number

Minimum quantization factor.

+

Optional qpMin

qpMin?: number

Minimum quantization factor.

Memberof

Vp8VideoConfiguration

-

Optional quality

quality?: Vp8Quality

Memberof

Vp8VideoConfiguration

-

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

+

Optional quality

quality?: Vp8Quality

Memberof

Vp8VideoConfiguration

+

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

Memberof

VideoConfiguration

-

Optional rateOvershootPct

rateOvershootPct?: number

Datarate overshoot (max) target (percentage).

+

Optional rateOvershootPct

rateOvershootPct?: number

Datarate overshoot (max) target (percentage).

Memberof

Vp8VideoConfiguration

-

Optional rateUndershootPct

rateUndershootPct?: number

Datarate undershoot (min) target (percentage).

+

Optional rateUndershootPct

rateUndershootPct?: number

Datarate undershoot (min) target (percentage).

Memberof

Vp8VideoConfiguration

-

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sharpness

sharpness?: number

Loop filter sharpness.

+

Optional sharpness

sharpness?: number

Loop filter sharpness.

Memberof

Vp8VideoConfiguration

-

Optional staticThresh

staticThresh?: number

A change threshold on blocks below which they will be skipped by the encoder.

+

Optional staticThresh

staticThresh?: number

A change threshold on blocks below which they will be skipped by the encoder.

Memberof

Vp8VideoConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.VP8

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.VP8

Discriminator property for CodecConfiguration

Memberof

Vp8VideoConfiguration

-

Optional width

width?: number

Width of the encoded video in pixels

+

Optional width

width?: number

Width of the encoded video in pixels

Memberof

VideoConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorarnrMaxFramesarnrStrengtharnrTypebitratecolorConfigcpuUsedcreatedAtcrfcustomDatadescriptiondisplayAspectRatioencodingModeheightidlagInFramesmaxGopmaxIntraRatemaxKeyframeIntervalminGopminKeyframeIntervalmodifiedAtnamenoiseSensitivitypixelFormatqpMaxqpMinqualityraterateOvershootPctrateUndershootPctsampleAspectRatioDenominatorsampleAspectRatioNumeratorsharpnessstaticThreshtypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorarnrMaxFramesarnrStrengtharnrTypebitratecolorConfigcpuUsedcreatedAtcrfcustomDatadescriptiondisplayAspectRatioencodingModeheightidlagInFramesmaxGopmaxIntraRatemaxKeyframeIntervalminGopminKeyframeIntervalmodifiedAtnamenoiseSensitivitypixelFormatqpMaxqpMinqualityraterateOvershootPctrateUndershootPctsampleAspectRatioDenominatorsampleAspectRatioNumeratorsharpnessstaticThreshtypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/Vp9PerTitleConfiguration.html b/docs/classes/Vp9PerTitleConfiguration.html index 8608b2769..49101f716 100644 --- a/docs/classes/Vp9PerTitleConfiguration.html +++ b/docs/classes/Vp9PerTitleConfiguration.html @@ -1,5 +1,5 @@ Vp9PerTitleConfiguration | @bitmovin/api-sdk

Class Vp9PerTitleConfiguration

Export

Vp9PerTitleConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

autoRepresentations? complexityFactor? fixedResolutionAndBitrateConfiguration? @@ -8,19 +8,19 @@ minBitrate? minBitrateStepSize? targetQualityCrf? -

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

-

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

+

Constructors

constructor

Properties

Optional autoRepresentations

autoRepresentations?: AutoRepresentation

Memberof

PerTitleConfiguration

+

Optional complexityFactor

complexityFactor?: number

Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition

Memberof

PerTitleConfiguration

-

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

+

Optional fixedResolutionAndBitrateConfiguration

fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration

Additional configuration for fixed resolution and bitrate templates

Memberof

PerTitleConfiguration

-

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

+

Optional maxBitrate

maxBitrate?: number

The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.

Memberof

PerTitleConfiguration

-

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

+

Optional maxBitrateStepSize

maxBitrateStepSize?: number

The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000

Memberof

PerTitleConfiguration

-

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

+

Optional minBitrate

minBitrate?: number

The minimum bitrate that will be used by the Per-Title algorithm.

Memberof

PerTitleConfiguration

-

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

+

Optional minBitrateStepSize

minBitrateStepSize?: number

The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000

Memberof

PerTitleConfiguration

-

Optional targetQualityCrf

targetQualityCrf?: number

Desired target quality of the highest representation expressed as CRF value

+

Optional targetQualityCrf

targetQualityCrf?: number

Desired target quality of the highest representation expressed as CRF value

Memberof

Vp9PerTitleConfiguration

-

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSizetargetQualityCrf
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorautoRepresentationscomplexityFactorfixedResolutionAndBitrateConfigurationmaxBitratemaxBitrateStepSizeminBitrateminBitrateStepSizetargetQualityCrf
\ No newline at end of file diff --git a/docs/classes/Vp9VideoConfiguration.html b/docs/classes/Vp9VideoConfiguration.html index 3e52c6a12..34aee35af 100644 --- a/docs/classes/Vp9VideoConfiguration.html +++ b/docs/classes/Vp9VideoConfiguration.html @@ -1,5 +1,5 @@ Vp9VideoConfiguration | @bitmovin/api-sdk

Class Vp9VideoConfiguration

Export

Vp9VideoConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

aqMode? arnrMaxFrames? arnrStrength? @@ -53,102 +53,102 @@ width? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional aqMode

aqMode?: Vp9AqMode

Memberof

Vp9VideoConfiguration

-

Optional arnrMaxFrames

arnrMaxFrames?: number

altref noise reduction max frame count.

+

Constructors

constructor

Properties

Optional aqMode

aqMode?: Vp9AqMode

Memberof

Vp9VideoConfiguration

+

Optional arnrMaxFrames

arnrMaxFrames?: number

altref noise reduction max frame count.

Memberof

Vp9VideoConfiguration

-

Optional arnrStrength

arnrStrength?: number

altref noise reduction filter strength.

+

Optional arnrStrength

arnrStrength?: number

altref noise reduction filter strength.

Memberof

Vp9VideoConfiguration

-

Optional arnrType

arnrType?: Vp9ArnrType

Memberof

Vp9VideoConfiguration

-

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting rateOvershootPct, or clientBufferSize properties will disable the automatic calculation.

+

Optional arnrType

arnrType?: Vp9ArnrType

Memberof

Vp9VideoConfiguration

+

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting rateOvershootPct, or clientBufferSize properties will disable the automatic calculation.

Memberof

Vp9VideoConfiguration

-

Optional automaticAltRefFramesEnabled

automaticAltRefFramesEnabled?: boolean

Enable automatic alternate reference frames (2pass only)

+

Optional automaticAltRefFramesEnabled

automaticAltRefFramesEnabled?: boolean

Enable automatic alternate reference frames (2pass only)

Memberof

Vp9VideoConfiguration

-

Optional biasPct

biasPct?: number

CBR/VBR bias (0=CBR, 100=VBR)

+

Optional biasPct

biasPct?: number

CBR/VBR bias (0=CBR, 100=VBR)

Memberof

Vp9VideoConfiguration

-

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

+

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Memberof

VideoConfiguration

-

Optional clientBufferSize

clientBufferSize?: number

Client buffer size (ms)

+

Optional clientBufferSize

clientBufferSize?: number

Client buffer size (ms)

Memberof

Vp9VideoConfiguration

-

Optional clientInitialBufferSize

clientInitialBufferSize?: number

Client initial buffer size (ms)

+

Optional clientInitialBufferSize

clientInitialBufferSize?: number

Client initial buffer size (ms)

Memberof

Vp9VideoConfiguration

-

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

-

Optional cpuUsed

cpuUsed?: number

Controls the tradeoff between compression efficiency and encoding speed. Higher values indicate a faster encoding. The minimum value for width * height >= 1280 * 720 is 2. If the value is too low it will be overridden.

+

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

+

Optional cpuUsed

cpuUsed?: number

Controls the tradeoff between compression efficiency and encoding speed. Higher values indicate a faster encoding. The minimum value for width * height >= 1280 * 720 is 2. If the value is too low it will be overridden.

Memberof

Vp9VideoConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

+

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

Memberof

Vp9VideoConfiguration

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

+

Optional displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Memberof

VideoConfiguration

-

Optional dynamicRangeFormat

dynamicRangeFormat?: Vp9DynamicRangeFormat

Automatically configures the VP9 Video Codec to be compatible with the given SDR/HLG format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.

+

Optional dynamicRangeFormat

dynamicRangeFormat?: Vp9DynamicRangeFormat

Automatically configures the VP9 Video Codec to be compatible with the given SDR/HLG format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.

Memberof

Vp9VideoConfiguration

-

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

+

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

Memberof

VideoConfiguration

-

Optional errorResiliencyEnabled

errorResiliencyEnabled?: boolean

Enables error resiliency feature

+

Optional errorResiliencyEnabled

errorResiliencyEnabled?: boolean

Enables error resiliency feature

Memberof

Vp9VideoConfiguration

-

Optional frameParallel

frameParallel?: boolean

Enable frame parallel decodability features

+

Optional frameParallel

frameParallel?: boolean

Enable frame parallel decodability features

Memberof

Vp9VideoConfiguration

-

Optional height

height?: number

Height of the encoded video in pixels

+

Optional height

height?: number

Height of the encoded video in pixels

Memberof

VideoConfiguration

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional lagInFrames

lagInFrames?: number

Number of frames to look ahead for alternate reference frame selection.

+

Optional lagInFrames

lagInFrames?: number

Number of frames to look ahead for alternate reference frame selection.

Memberof

Vp9VideoConfiguration

-

Optional lossless

lossless?: boolean

Lossless mode

+

Optional lossless

lossless?: boolean

Lossless mode

Memberof

Vp9VideoConfiguration

-

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

+

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

Memberof

Vp9VideoConfiguration

-

Optional maxIntraRate

maxIntraRate?: number

Maximum I-frame bitrate (percentage) 0=unlimited

+

Optional maxIntraRate

maxIntraRate?: number

Maximum I-frame bitrate (percentage) 0=unlimited

Memberof

Vp9VideoConfiguration

-

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

+

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

Memberof

Vp9VideoConfiguration

-

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames.

+

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames.

Memberof

Vp9VideoConfiguration

-

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

+

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

Memberof

Vp9VideoConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional noiseSensitivity

noiseSensitivity?: boolean

Enable noise sensitivity on Y channel

+

Optional noiseSensitivity

noiseSensitivity?: boolean

Enable noise sensitivity on Y channel

Memberof

Vp9VideoConfiguration

-

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

+

Optional pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Memberof

VideoConfiguration

-

Optional presetConfiguration

presetConfiguration?: PresetConfiguration

Choose from a set of preset configurations tailored for common use cases. Check out VP9 Presets to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.

+

Optional presetConfiguration

presetConfiguration?: PresetConfiguration

Choose from a set of preset configurations tailored for common use cases. Check out VP9 Presets to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.

Memberof

Vp9VideoConfiguration

-

Optional qpMax

qpMax?: number

Maximum quantization factor.

+

Optional qpMax

qpMax?: number

Maximum quantization factor.

Memberof

Vp9VideoConfiguration

-

Optional qpMin

qpMin?: number

Minimum quantization factor.

+

Optional qpMin

qpMin?: number

Minimum quantization factor.

Memberof

Vp9VideoConfiguration

-

Optional quality

quality?: Vp9Quality

Memberof

Vp9VideoConfiguration

-

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

+

Optional quality

quality?: Vp9Quality

Memberof

Vp9VideoConfiguration

+

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

Memberof

VideoConfiguration

-

Optional rateOvershootPct

rateOvershootPct?: number

Datarate overshoot (max) target (percentage).

+

Optional rateOvershootPct

rateOvershootPct?: number

Datarate overshoot (max) target (percentage).

Memberof

Vp9VideoConfiguration

-

Optional rateUndershootPct

rateUndershootPct?: number

Datarate undershoot (min) target (percentage).

+

Optional rateUndershootPct

rateUndershootPct?: number

Datarate undershoot (min) target (percentage).

Memberof

Vp9VideoConfiguration

-

Optional rowMultiThreadingEnabled

rowMultiThreadingEnabled?: boolean

Enable row based non-deterministic multi-threading

+

Optional rowMultiThreadingEnabled

rowMultiThreadingEnabled?: boolean

Enable row based non-deterministic multi-threading

Memberof

Vp9VideoConfiguration

-

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

+

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

-

Optional sharpness

sharpness?: number

Loop filter sharpness.

+

Optional sharpness

sharpness?: number

Loop filter sharpness.

Memberof

Vp9VideoConfiguration

-

Optional staticThresh

staticThresh?: number

A change threshold on blocks below which they will be skipped by the encoder.

+

Optional staticThresh

staticThresh?: number

A change threshold on blocks below which they will be skipped by the encoder.

Memberof

Vp9VideoConfiguration

-

Optional targetLevel

targetLevel?: number

Target level (255: off, 0: only keep level stats; 10: level 1.0; 11: level 1.1; ... 62: level 6.2)

+

Optional targetLevel

targetLevel?: number

Target level (255: off, 0: only keep level stats; 10: level 1.0; 11: level 1.1; ... 62: level 6.2)

Memberof

Vp9VideoConfiguration

-

Optional tileColumns

tileColumns?: number

Number of tile columns to use, log2. Depending on the encoding width there are limitations on this value. The minimum values are 2 for width >= 1920 and 1 for width >= 1280. The minimum width of each tile is 256 pixels so the maximum values are 0 for width < 256, 1 for width < 512, 2 for width < 1024, 3 for width < 2048, 4 for width < 4096, 5 for width < 8192. If the value is too high or too low it will be overridden.

+

Optional tileColumns

tileColumns?: number

Number of tile columns to use, log2. Depending on the encoding width there are limitations on this value. The minimum values are 2 for width >= 1920 and 1 for width >= 1280. The minimum width of each tile is 256 pixels so the maximum values are 0 for width < 256, 1 for width < 512, 2 for width < 1024, 3 for width < 2048, 4 for width < 4096, 5 for width < 8192. If the value is too high or too low it will be overridden.

Memberof

Vp9VideoConfiguration

-

Optional tileRows

tileRows?: number

Number of tile rows to use, log2.

+

Optional tileRows

tileRows?: number

Number of tile rows to use, log2.

Memberof

Vp9VideoConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.VP9

Discriminator property for CodecConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.VP9

Discriminator property for CodecConfiguration

Memberof

Vp9VideoConfiguration

-

Optional width

width?: number

Width of the encoded video in pixels

+

Optional width

width?: number

Width of the encoded video in pixels

Memberof

VideoConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraqModearnrMaxFramesarnrStrengtharnrTypeautoLevelSetupautomaticAltRefFramesEnabledbiasPctbitrateclientBufferSizeclientInitialBufferSizecolorConfigcpuUsedcreatedAtcrfcustomDatadescriptiondisplayAspectRatiodynamicRangeFormatencodingModeerrorResiliencyEnabledframeParallelheightidlagInFrameslosslessmaxGopmaxIntraRatemaxKeyframeIntervalminGopminKeyframeIntervalmodifiedAtnamenoiseSensitivitypixelFormatpresetConfigurationqpMaxqpMinqualityraterateOvershootPctrateUndershootPctrowMultiThreadingEnabledsampleAspectRatioDenominatorsampleAspectRatioNumeratorsharpnessstaticThreshtargetLeveltileColumnstileRowstypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoraqModearnrMaxFramesarnrStrengtharnrTypeautoLevelSetupautomaticAltRefFramesEnabledbiasPctbitrateclientBufferSizeclientInitialBufferSizecolorConfigcpuUsedcreatedAtcrfcustomDatadescriptiondisplayAspectRatiodynamicRangeFormatencodingModeerrorResiliencyEnabledframeParallelheightidlagInFrameslosslessmaxGopmaxIntraRatemaxKeyframeIntervalminGopminKeyframeIntervalmodifiedAtnamenoiseSensitivitypixelFormatpresetConfigurationqpMaxqpMinqualityraterateOvershootPctrateUndershootPctrowMultiThreadingEnabledsampleAspectRatioDenominatorsampleAspectRatioNumeratorsharpnessstaticThreshtargetLeveltileColumnstileRowstypewidth_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/VttMediaInfo.html b/docs/classes/VttMediaInfo.html index 7b1135a71..dba394c07 100644 --- a/docs/classes/VttMediaInfo.html +++ b/docs/classes/VttMediaInfo.html @@ -1,5 +1,5 @@ VttMediaInfo | @bitmovin/api-sdk

Class VttMediaInfo

Export

VttMediaInfo

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assocLanguage? autoselect? characteristics? @@ -11,26 +11,26 @@ name? uri? vttUrl? -

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

+

Constructors

constructor

Properties

Optional assocLanguage

assocLanguage?: string

Identifies a language that is associated with the Rendition.

Memberof

BasicMediaInfo

-

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

+

Optional autoselect

autoselect?: boolean

If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.

Memberof

BasicMediaInfo

-

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

+

Optional characteristics

characteristics?: string[]

Contains Uniform Type Identifiers

Memberof

BasicMediaInfo

-

Optional forced

forced?: boolean

A value of true indicates that the Rendition contains content which is considered essential to play.

+

Optional forced

forced?: boolean

A value of true indicates that the Rendition contains content which is considered essential to play.

Memberof

VttMediaInfo

-

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

+

Optional groupId

groupId?: string

The value is a quoted-string which specifies the group to which the Rendition belongs. (required)

Memberof

BasicMediaInfo

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

+

Optional isDefault

isDefault?: boolean

If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.

Memberof

BasicMediaInfo

-

Optional language

language?: string

Primary language in the rendition.

+

Optional language

language?: string

Primary language in the rendition.

Memberof

BasicMediaInfo

-

Optional name

name?: string

Human readable description of the rendition. (required)

+

Optional name

name?: string

Human readable description of the rendition. (required)

Memberof

BasicMediaInfo

-

Optional uri

uri?: string

The URI of the Rendition (required)

+

Optional uri

uri?: string

The URI of the Rendition (required)

Memberof

VttMediaInfo

-

Optional vttUrl

vttUrl?: string

The URL of the referenced VTT file (required)

+

Optional vttUrl

vttUrl?: string

The URL of the referenced VTT file (required)

Memberof

VttMediaInfo

-

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsforcedgroupIdidisDefaultlanguagenameurivttUrl
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorassocLanguageautoselectcharacteristicsforcedgroupIdidisDefaultlanguagenameurivttUrl
\ No newline at end of file diff --git a/docs/classes/WatchFolder.html b/docs/classes/WatchFolder.html index 08fa6f927..c8650f377 100644 --- a/docs/classes/WatchFolder.html +++ b/docs/classes/WatchFolder.html @@ -1,5 +1,5 @@ WatchFolder | @bitmovin/api-sdk

Class WatchFolder

Export

WatchFolder

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -10,22 +10,22 @@ outputs? status? statusText? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional input

input?: WatchFolderInput

Memberof

WatchFolder

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional input

input?: WatchFolderInput

Memberof

WatchFolder

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: WatchFolderOutput[]

Memberof

WatchFolder

-

Optional status

status?: WatchFolderStatus

The current status of the Watch Folder. The default value is STOPPED (required)

+

Optional outputs

outputs?: WatchFolderOutput[]

Memberof

WatchFolder

+

Optional status

status?: WatchFolderStatus

The current status of the Watch Folder. The default value is STOPPED (required)

Memberof

WatchFolder

-

Optional statusText

statusText?: string

A description text of the current status (required)

+

Optional statusText

statusText?: string

A description text of the current status (required)

Memberof

WatchFolder

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputmodifiedAtnameoutputsstatusstatusText
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinputmodifiedAtnameoutputsstatusstatusText
\ No newline at end of file diff --git a/docs/classes/WatchFolderInput.html b/docs/classes/WatchFolderInput.html index c1b396cbf..eb896f1e3 100644 --- a/docs/classes/WatchFolderInput.html +++ b/docs/classes/WatchFolderInput.html @@ -1,9 +1,9 @@ WatchFolderInput | @bitmovin/api-sdk

Class WatchFolderInput

Export

WatchFolderInput

-

Constructors

constructor +

Constructors

constructor

Properties

inputId? inputPath? -

Constructors

constructor

Properties

Optional inputId

inputId?: string

Input id (required)

+

Constructors

constructor

Properties

Optional inputId

inputId?: string

Input id (required)

Memberof

WatchFolderInput

-

Optional inputPath

inputPath?: string

Path of the directory to monitor (required)

+

Optional inputPath

inputPath?: string

Path of the directory to monitor (required)

Memberof

WatchFolderInput

-

Settings

Member Visibility

Theme

On This Page

constructorinputIdinputPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorinputIdinputPath
\ No newline at end of file diff --git a/docs/classes/WatchFolderOutput.html b/docs/classes/WatchFolderOutput.html index bf2131de2..7da3fa813 100644 --- a/docs/classes/WatchFolderOutput.html +++ b/docs/classes/WatchFolderOutput.html @@ -1,9 +1,9 @@ WatchFolderOutput | @bitmovin/api-sdk

Class WatchFolderOutput

Export

WatchFolderOutput

-

Constructors

constructor +

Constructors

constructor

Properties

outputId? outputPath? -

Constructors

constructor

Properties

Optional outputId

outputId?: string

Id of the corresponding output (required)

+

Constructors

constructor

Properties

Optional outputId

outputId?: string

Id of the corresponding output (required)

Memberof

WatchFolderOutput

-

Optional outputPath

outputPath?: string

Subdirectory where to save the files to (required)

+

Optional outputPath

outputPath?: string

Subdirectory where to save the files to (required)

Memberof

WatchFolderOutput

-

Settings

Member Visibility

Theme

On This Page

constructoroutputIdoutputPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoroutputIdoutputPath
\ No newline at end of file diff --git a/docs/classes/WatermarkFilter.html b/docs/classes/WatermarkFilter.html index c6a9b3f74..c2422fdf6 100644 --- a/docs/classes/WatermarkFilter.html +++ b/docs/classes/WatermarkFilter.html @@ -1,5 +1,5 @@ WatermarkFilter | @bitmovin/api-sdk

Class WatermarkFilter

Export

WatermarkFilter

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bottom? createdAt? customData? @@ -15,30 +15,30 @@ unit? _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional bottom

bottom?: number

Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.

+

Constructors

constructor

Properties

Optional bottom

bottom?: number

Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.

Memberof

WatermarkFilter

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional image

image?: string

URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)

+

Optional image

image?: string

URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)

Memberof

WatermarkFilter

-

Optional left

left?: number

Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.

+

Optional left

left?: number

Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.

Memberof

WatermarkFilter

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional right

right?: number

Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.

+

Optional right

right?: number

Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.

Memberof

WatermarkFilter

-

Optional top

top?: number

Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.

+

Optional top

top?: number

Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.

Memberof

WatermarkFilter

-

Readonly type

type: FilterType = FilterType.WATERMARK

Discriminator property for Filter

+

Readonly type

type: FilterType = FilterType.WATERMARK

Discriminator property for Filter

Memberof

WatermarkFilter

-

Optional unit

unit?: PositionUnit

Specifies if the values of 'left', 'right', 'top' and 'bottom' are interpreted as pixels or as a percentage of the input video's dimensions.

+

Optional unit

unit?: PositionUnit

Specifies if the values of 'left', 'right', 'top' and 'bottom' are interpreted as pixels or as a percentage of the input video's dimensions.

Memberof

WatermarkFilter

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

  • AUDIO_MIX: string
  • AUDIO_VOLUME: string
  • AZURE_SPEECH_TO_CAPTIONS: string
  • CONFORM: string
  • CROP: string
  • DEINTERLACE: string
  • DENOISE_HQDN3D: string
  • EBU_R128_SINGLE_PASS: string
  • ENHANCED_DEINTERLACE: string
  • ENHANCED_WATERMARK: string
  • INTERLACE: string
  • ROTATE: string
  • SCALE: string
  • TEXT: string
  • UNSHARP: string
  • WATERMARK: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbottomcreatedAtcustomDatadescriptionidimageleftmodifiedAtnamerighttoptypeunit_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AUDIO_MIX: string;
    AUDIO_VOLUME: string;
    AZURE_SPEECH_TO_CAPTIONS: string;
    CONFORM: string;
    CROP: string;
    DEINTERLACE: string;
    DENOISE_HQDN3D: string;
    EBU_R128_SINGLE_PASS: string;
    ENHANCED_DEINTERLACE: string;
    ENHANCED_WATERMARK: string;
    INTERLACE: string;
    ROTATE: string;
    SCALE: string;
    TEXT: string;
    UNSHARP: string;
    WATERMARK: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbottomcreatedAtcustomDatadescriptionidimageleftmodifiedAtnamerighttoptypeunit_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/WebVttConfiguration.html b/docs/classes/WebVttConfiguration.html index 421064ff4..5e99b3ce1 100644 --- a/docs/classes/WebVttConfiguration.html +++ b/docs/classes/WebVttConfiguration.html @@ -1,5 +1,5 @@ WebVttConfiguration | @bitmovin/api-sdk

Class WebVttConfiguration

Export

WebVttConfiguration

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

appendOptionalZeroHour? createdAt? cueIdentifierPolicy? @@ -13,24 +13,24 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional appendOptionalZeroHour

appendOptionalZeroHour?: boolean

If set to true, the hours section on webvtt timestamp values will explicitely have zeroes instead of being omitted for values where hours = 0.

+

Constructors

constructor

Properties

Optional appendOptionalZeroHour

appendOptionalZeroHour?: boolean

If set to true, the hours section on webvtt timestamp values will explicitely have zeroes instead of being omitted for values where hours = 0.

Memberof

WebVttConfiguration

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional cueIdentifierPolicy

cueIdentifierPolicy?: WebVttCueIdentifierPolicy

Memberof

WebVttConfiguration

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional cueIdentifierPolicy

cueIdentifierPolicy?: WebVttCueIdentifierPolicy

Memberof

WebVttConfiguration

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoreRegion

ignoreRegion?: boolean

If set to true, the region information of the resulting webvtt file will be omitted. Defaults to false.

+

Optional ignoreRegion

ignoreRegion?: boolean

If set to true, the region information of the resulting webvtt file will be omitted. Defaults to false.

Memberof

WebVttConfiguration

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional styling

styling?: WebVttStyling

Memberof

WebVttConfiguration

-

Readonly type

type: CodecConfigType = CodecConfigType.WEBVTT

Discriminator property for CodecConfiguration

+

Optional styling

styling?: WebVttStyling

Memberof

WebVttConfiguration

+

Readonly type

type: CodecConfigType = CodecConfigType.WEBVTT

Discriminator property for CodecConfiguration

Memberof

WebVttConfiguration

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorappendOptionalZeroHourcreatedAtcueIdentifierPolicycustomDatadescriptionidignoreRegionmodifiedAtnamestylingtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorappendOptionalZeroHourcreatedAtcueIdentifierPolicycustomDatadescriptionidignoreRegionmodifiedAtnamestylingtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/WebVttSidecarFile.html b/docs/classes/WebVttSidecarFile.html index 6a9282cd2..3b61d3089 100644 --- a/docs/classes/WebVttSidecarFile.html +++ b/docs/classes/WebVttSidecarFile.html @@ -1,6 +1,6 @@ WebVttSidecarFile | @bitmovin/api-sdk

Class WebVttSidecarFile

An external WebVTT file that is added to an encoding. The size limit for a sidecar file is 10 MB

Export

WebVttSidecarFile

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -15,26 +15,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional errorMode

errorMode?: SidecarErrorMode

This defines how errors should be handled

+

Optional errorMode

errorMode?: SidecarErrorMode

This defines how errors should be handled

Memberof

SidecarFile

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional inputId

inputId?: string

Id of input (required)

+

Optional inputId

inputId?: string

Id of input (required)

Memberof

SidecarFile

-

Optional inputPath

inputPath?: string

Path to sidecar file (required)

+

Optional inputPath

inputPath?: string

Path to sidecar file (required)

Memberof

SidecarFile

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

SidecarFile

-

Optional segmentation

segmentation?: WebVttSidecarFileSegmentation

Memberof

WebVttSidecarFile

-

Readonly type

type: WEB_VTT = SidecarFileType.WEB_VTT

Discriminator property for SidecarFile

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

SidecarFile

+

Optional segmentation

segmentation?: WebVttSidecarFileSegmentation

Memberof

WebVttSidecarFile

+

Readonly type

type: WEB_VTT = SidecarFileType.WEB_VTT

Discriminator property for SidecarFile

Memberof

WebVttSidecarFile

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    WEB_VTT: string;
} = ...

Type declaration

  • WEB_VTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionerrorModeidinputIdinputPathmodifiedAtnameoutputssegmentationtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    WEB_VTT: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionerrorModeidinputIdinputPathmodifiedAtnameoutputssegmentationtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/WebVttSidecarFileSegmentation.html b/docs/classes/WebVttSidecarFileSegmentation.html index c530f61c9..80e7c2601 100644 --- a/docs/classes/WebVttSidecarFileSegmentation.html +++ b/docs/classes/WebVttSidecarFileSegmentation.html @@ -1,7 +1,7 @@ WebVttSidecarFileSegmentation | @bitmovin/api-sdk

Class WebVttSidecarFileSegmentation

The segmenting configuration for this WebVTT sidecar file. If this is set, the given vtt file will be chunked.

Export

WebVttSidecarFileSegmentation

-

Constructors

constructor +

Constructors

constructor

Properties

segmentLength? -

Constructors

constructor

Properties

Optional segmentLength

segmentLength?: number

The length of the WebVTT fragments in seconds (required)

+

Constructors

constructor

Properties

Optional segmentLength

segmentLength?: number

The length of the WebVTT fragments in seconds (required)

Memberof

WebVttSidecarFileSegmentation

-

Settings

Member Visibility

Theme

On This Page

constructorsegmentLength
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorsegmentLength
\ No newline at end of file diff --git a/docs/classes/WebVttStyling.html b/docs/classes/WebVttStyling.html index d2d5c807a..014726ac1 100644 --- a/docs/classes/WebVttStyling.html +++ b/docs/classes/WebVttStyling.html @@ -1,5 +1,5 @@ WebVttStyling | @bitmovin/api-sdk

Class WebVttStyling

Export

WebVttStyling

-

Constructors

constructor +

Constructors

constructor

Properties

mode? -

Constructors

constructor

Properties

Optional mode

mode?: WebVttStylingMode

Memberof

WebVttStyling

-

Settings

Member Visibility

Theme

On This Page

constructormode
\ No newline at end of file +

Constructors

constructor

Properties

Optional mode

mode?: WebVttStylingMode

Memberof

WebVttStyling

+

Settings

Member Visibility

Theme

On This Page

constructormode
\ No newline at end of file diff --git a/docs/classes/Webhook.html b/docs/classes/Webhook.html index 098b4f857..916af3b59 100644 --- a/docs/classes/Webhook.html +++ b/docs/classes/Webhook.html @@ -1,5 +1,5 @@ Webhook | @bitmovin/api-sdk

Class Webhook

Export

Webhook

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -11,26 +11,26 @@ schema? signature? url? -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional insecureSsl

insecureSsl?: boolean

Skip verification of the SSL certificate

+

Optional insecureSsl

insecureSsl?: boolean

Skip verification of the SSL certificate

Memberof

Webhook

-

Optional method

method?: WebhookHttpMethod

HTTP method used for the webhook

+

Optional method

method?: WebhookHttpMethod

HTTP method used for the webhook

Memberof

Webhook

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional schema

schema?: any

JSON schema of the webhook payload

+

Optional schema

schema?: any

JSON schema of the webhook payload

Memberof

Webhook

-

Optional signature

signature?: WebhookSignature

Signature used for the webhook

+

Optional signature

signature?: WebhookSignature

Signature used for the webhook

Memberof

Webhook

-

Optional url

url?: string

Webhook URL (required)

+

Optional url

url?: string

Webhook URL (required)

Memberof

Webhook

-

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinsecureSslmethodmodifiedAtnameschemasignatureurl
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidinsecureSslmethodmodifiedAtnameschemasignatureurl
\ No newline at end of file diff --git a/docs/classes/WebhookNotification.html b/docs/classes/WebhookNotification.html index 899ab71e7..5cd30e6fc 100644 --- a/docs/classes/WebhookNotification.html +++ b/docs/classes/WebhookNotification.html @@ -1,5 +1,5 @@ WebhookNotification | @bitmovin/api-sdk

Class WebhookNotification

Export

WebhookNotification

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

category? customData? eventType? @@ -14,27 +14,27 @@ triggeredAt? type? url? -

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

Notification

-

Optional eventType

eventType?: string

Memberof

Notification

-

Optional id

id?: string

Id of the resource (required)

+

Optional eventType

eventType?: string

Memberof

Notification

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional insecureSsl

insecureSsl?: boolean

Skip verification of the SSL certificate

+

Optional insecureSsl

insecureSsl?: boolean

Skip verification of the SSL certificate

Memberof

WebhookNotification

-

Optional method

method?: WebhookHttpMethod

HTTP method used for the webhook

+

Optional method

method?: WebhookHttpMethod

HTTP method used for the webhook

Memberof

WebhookNotification

-

Optional muted

muted?: boolean

Memberof

Notification

-

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

+

Optional muted

muted?: boolean

Memberof

Notification

+

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

Memberof

Notification

-

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

+

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

Memberof

Notification

-

Optional resourceType

resourceType?: string

Memberof

Notification

-

Optional signature

signature?: WebhookSignature

Signature used for the webhook

+

Optional resourceType

resourceType?: string

Memberof

Notification

+

Optional signature

signature?: WebhookSignature

Signature used for the webhook

Memberof

WebhookNotification

-

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

+

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

Memberof

Notification

-

Optional type

type?: string

Memberof

Notification

-

Optional url

url?: string

The destination URL where the webhook data is send to (required)

+

Optional type

type?: string

Memberof

Notification

+

Optional url

url?: string

The destination URL where the webhook data is send to (required)

Memberof

WebhookNotification

-

Settings

Member Visibility

Theme

On This Page

constructorcategorycustomDataeventTypeidinsecureSslmethodmutedresolveresourceIdresourceTypesignaturetriggeredAttypeurl
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcategorycustomDataeventTypeidinsecureSslmethodmutedresolveresourceIdresourceTypesignaturetriggeredAttypeurl
\ No newline at end of file diff --git a/docs/classes/WebhookNotificationWithStreamConditions.html b/docs/classes/WebhookNotificationWithStreamConditions.html index 6eeaf5097..8132ef082 100644 --- a/docs/classes/WebhookNotificationWithStreamConditions.html +++ b/docs/classes/WebhookNotificationWithStreamConditions.html @@ -1,5 +1,5 @@ WebhookNotificationWithStreamConditions | @bitmovin/api-sdk

Class WebhookNotificationWithStreamConditions

Export

WebhookNotificationWithStreamConditions

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

category? conditions? customData? @@ -15,28 +15,28 @@ triggeredAt? type? url? -

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

-

Optional conditions

conditions?: AbstractCondition

Memberof

WebhookNotificationWithStreamConditions

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

+

Optional conditions

conditions?: AbstractCondition

Memberof

WebhookNotificationWithStreamConditions

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

Notification

-

Optional eventType

eventType?: string

Memberof

Notification

-

Optional id

id?: string

Id of the resource (required)

+

Optional eventType

eventType?: string

Memberof

Notification

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional insecureSsl

insecureSsl?: boolean

Skip verification of the SSL certificate

+

Optional insecureSsl

insecureSsl?: boolean

Skip verification of the SSL certificate

Memberof

WebhookNotification

-

Optional method

method?: WebhookHttpMethod

HTTP method used for the webhook

+

Optional method

method?: WebhookHttpMethod

HTTP method used for the webhook

Memberof

WebhookNotification

-

Optional muted

muted?: boolean

Memberof

Notification

-

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

+

Optional muted

muted?: boolean

Memberof

Notification

+

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

Memberof

Notification

-

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

+

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

Memberof

Notification

-

Optional resourceType

resourceType?: string

Memberof

Notification

-

Optional signature

signature?: WebhookSignature

Signature used for the webhook

+

Optional resourceType

resourceType?: string

Memberof

Notification

+

Optional signature

signature?: WebhookSignature

Signature used for the webhook

Memberof

WebhookNotification

-

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

+

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

Memberof

Notification

-

Optional type

type?: string

Memberof

Notification

-

Optional url

url?: string

The destination URL where the webhook data is send to (required)

+

Optional type

type?: string

Memberof

Notification

+

Optional url

url?: string

The destination URL where the webhook data is send to (required)

Memberof

WebhookNotification

-

Settings

Member Visibility

Theme

On This Page

constructorcategoryconditionscustomDataeventTypeidinsecureSslmethodmutedresolveresourceIdresourceTypesignaturetriggeredAttypeurl
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcategoryconditionscustomDataeventTypeidinsecureSslmethodmutedresolveresourceIdresourceTypesignaturetriggeredAttypeurl
\ No newline at end of file diff --git a/docs/classes/WebhookNotificationWithStreamConditionsRequest.html b/docs/classes/WebhookNotificationWithStreamConditionsRequest.html index 59ac33aa1..6c0178c6a 100644 --- a/docs/classes/WebhookNotificationWithStreamConditionsRequest.html +++ b/docs/classes/WebhookNotificationWithStreamConditionsRequest.html @@ -1,5 +1,5 @@ WebhookNotificationWithStreamConditionsRequest | @bitmovin/api-sdk

Class WebhookNotificationWithStreamConditionsRequest

Export

WebhookNotificationWithStreamConditionsRequest

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

category? conditions? customData? @@ -15,28 +15,28 @@ triggeredAt? type? url? -

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

-

Optional conditions

conditions?: AbstractCondition

Memberof

WebhookNotificationWithStreamConditionsRequest

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Constructors

constructor

Properties

Optional category

category?: string

Memberof

Notification

+

Optional conditions

conditions?: AbstractCondition

Memberof

WebhookNotificationWithStreamConditionsRequest

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

Notification

-

Optional eventType

eventType?: string

Memberof

Notification

-

Optional id

id?: string

Id of the resource (required)

+

Optional eventType

eventType?: string

Memberof

Notification

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional insecureSsl

insecureSsl?: boolean

Skip verification of the SSL certificate

+

Optional insecureSsl

insecureSsl?: boolean

Skip verification of the SSL certificate

Memberof

WebhookNotification

-

Optional method

method?: WebhookHttpMethod

HTTP method used for the webhook

+

Optional method

method?: WebhookHttpMethod

HTTP method used for the webhook

Memberof

WebhookNotification

-

Optional muted

muted?: boolean

Memberof

Notification

-

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

+

Optional muted

muted?: boolean

Memberof

Notification

+

Optional resolve

resolve?: boolean

Notify when condition resolves after it was met

Memberof

Notification

-

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

+

Optional resourceId

resourceId?: string

Specific resource, e.g. encoding id

Memberof

Notification

-

Optional resourceType

resourceType?: string

Memberof

Notification

-

Optional signature

signature?: WebhookSignature

Signature used for the webhook

+

Optional resourceType

resourceType?: string

Memberof

Notification

+

Optional signature

signature?: WebhookSignature

Signature used for the webhook

Memberof

WebhookNotification

-

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

+

Optional triggeredAt

triggeredAt?: Date

Last time the notification was triggered

Memberof

Notification

-

Optional type

type?: string

Memberof

Notification

-

Optional url

url?: string

The destination URL where the webhook data is send to (required)

+

Optional type

type?: string

Memberof

Notification

+

Optional url

url?: string

The destination URL where the webhook data is send to (required)

Memberof

WebhookNotification

-

Settings

Member Visibility

Theme

On This Page

constructorcategoryconditionscustomDataeventTypeidinsecureSslmethodmutedresolveresourceIdresourceTypesignaturetriggeredAttypeurl
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcategoryconditionscustomDataeventTypeidinsecureSslmethodmutedresolveresourceIdresourceTypesignaturetriggeredAttypeurl
\ No newline at end of file diff --git a/docs/classes/WebhookSignature.html b/docs/classes/WebhookSignature.html index 6967be165..0bf461751 100644 --- a/docs/classes/WebhookSignature.html +++ b/docs/classes/WebhookSignature.html @@ -1,9 +1,9 @@ WebhookSignature | @bitmovin/api-sdk

Class WebhookSignature

Export

WebhookSignature

-

Constructors

constructor +

Constructors

constructor

Properties

key? type? -

Constructors

constructor

Properties

Optional key

key?: string

The key of the signature (required)

+

Constructors

constructor

Properties

Optional key

key?: string

The key of the signature (required)

Memberof

WebhookSignature

-

Optional type

type?: HMAC

The signature type used for the webhook. Selects one of the supported signatures. The signature is attached to the list of headers with the key Bitmovin-Signature. In case of the HMAC type the SHA512 hashing algorithm is used to generate an authentication code from the webhook body. (required)

+

Optional type

type?: HMAC

The signature type used for the webhook. Selects one of the supported signatures. The signature is attached to the list of headers with the key Bitmovin-Signature. In case of the HMAC type the SHA512 hashing algorithm is used to generate an authentication code from the webhook body. (required)

Memberof

WebhookSignature

-

Settings

Member Visibility

Theme

On This Page

constructorkeytype
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorkeytype
\ No newline at end of file diff --git a/docs/classes/WebmMuxing.html b/docs/classes/WebmMuxing.html index 8f134b8b3..59e8702c8 100644 --- a/docs/classes/WebmMuxing.html +++ b/docs/classes/WebmMuxing.html @@ -1,5 +1,5 @@ WebmMuxing | @bitmovin/api-sdk

Class WebmMuxing

Export

WebmMuxing

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? @@ -22,42 +22,42 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

+

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

+

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

-

Optional initSegmentName

initSegmentName?: string

Init segment name

+

Optional initSegmentName

initSegmentName?: string

Init segment name

Memberof

WebmMuxing

-

Optional initSegmentNameTemplate

initSegmentNameTemplate?: string

Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.

+

Optional initSegmentNameTemplate

initSegmentNameTemplate?: string

Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.

Memberof

WebmMuxing

-

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

+

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

+

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

-

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

+

Optional segmentLength

segmentLength?: number

Length of the fragments in seconds (required)

Memberof

WebmMuxing

-

Optional segmentNaming

segmentNaming?: string

Segment naming policy

+

Optional segmentNaming

segmentNaming?: string

Segment naming policy

Memberof

WebmMuxing

-

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

+

Optional segmentNamingTemplate

segmentNamingTemplate?: string

Segment naming policy containing one or both of the following placeholders: - '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.

Memberof

WebmMuxing

-

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

+

Optional segmentsMuxed

segmentsMuxed?: number

Number of segments which have been encoded

Memberof

WebmMuxing

-

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

+

Optional streamConditionsMode

streamConditionsMode?: StreamConditionsMode

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Memberof

Muxing

-

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

-

Readonly type

type: MuxingType = MuxingType.WEBM

Discriminator property for Muxing

+

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

+

Readonly type

type: MuxingType = MuxingType.WEBM

Discriminator property for Muxing

Memberof

WebmMuxing

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredByinitSegmentNameinitSegmentNameTemplatemaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionidignoredByinitSegmentNameinitSegmentNameTemplatemaxBitrateminBitratemodifiedAtnameoutputssegmentLengthsegmentNamingsegmentNamingTemplatesegmentsMuxedstreamConditionsModestreamstype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/WidevineDrm.html b/docs/classes/WidevineDrm.html index aaa211f4b..43edebac4 100644 --- a/docs/classes/WidevineDrm.html +++ b/docs/classes/WidevineDrm.html @@ -1,5 +1,5 @@ WidevineDrm | @bitmovin/api-sdk

Class WidevineDrm

Export

WidevineDrm

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? @@ -13,25 +13,25 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional id

id?: string

Id of the resource (required)

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional key

key?: string

16 byte Encryption key, 32 hexadecimal characters (required)

+

Optional key

key?: string

16 byte Encryption key, 32 hexadecimal characters (required)

Memberof

WidevineDrm

-

Optional kid

kid?: string

16 byte Key id, 32 hexadecimal characters (required)

+

Optional kid

kid?: string

16 byte Key id, 32 hexadecimal characters (required)

Memberof

WidevineDrm

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

-

Optional pssh

pssh?: string

Base 64 Encoded (required)

+

Optional outputs

outputs?: EncodingOutput[]

Memberof

Drm

+

Optional pssh

pssh?: string

Base 64 Encoded (required)

Memberof

WidevineDrm

-

Readonly type

type: DrmType = DrmType.WIDEVINE

Discriminator property for Drm

+

Readonly type

type: DrmType = DrmType.WIDEVINE

Discriminator property for Drm

Memberof

WidevineDrm

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

  • AES: string
  • CENC: string
  • CLEARKEY: string
  • FAIRPLAY: string
  • MARLIN: string
  • PLAYREADY: string
  • PRIMETIME: string
  • SPEKE: string
  • WIDEVINE: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidkeykidmodifiedAtnameoutputspsshtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AES: string;
    CENC: string;
    CLEARKEY: string;
    FAIRPLAY: string;
    MARLIN: string;
    PLAYREADY: string;
    PRIMETIME: string;
    SPEKE: string;
    WIDEVINE: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionidkeykidmodifiedAtnameoutputspsshtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/XmlNamespace.html b/docs/classes/XmlNamespace.html index 379a7f4e6..59de780e2 100644 --- a/docs/classes/XmlNamespace.html +++ b/docs/classes/XmlNamespace.html @@ -1,9 +1,9 @@ XmlNamespace | @bitmovin/api-sdk

Class XmlNamespace

Export

XmlNamespace

-

Constructors

constructor +

Constructors

constructor

Properties

prefix? uri? -

Constructors

constructor

Properties

Optional prefix

prefix?: string

Name of the XML Namespace reference (required)

+

Constructors

constructor

Properties

Optional prefix

prefix?: string

Name of the XML Namespace reference (required)

Memberof

XmlNamespace

-

Optional uri

uri?: string

Source of the XML Namespace reference (required)

+

Optional uri

uri?: string

Source of the XML Namespace reference (required)

Memberof

XmlNamespace

-

Settings

Member Visibility

Theme

On This Page

constructorprefixuri
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorprefixuri
\ No newline at end of file diff --git a/docs/classes/ZixiInput.html b/docs/classes/ZixiInput.html index f61313779..29295caaa 100644 --- a/docs/classes/ZixiInput.html +++ b/docs/classes/ZixiInput.html @@ -1,5 +1,5 @@ ZixiInput | @bitmovin/api-sdk

Class ZixiInput

Export

ZixiInput

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? decryptionKey? @@ -17,26 +17,26 @@ type _discriminatorMapping _discriminatorName -

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

+

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

-

Optional decryptionKey

decryptionKey?: string

Memberof

ZixiInput

-

Optional decryptionType

decryptionType?: string

Memberof

ZixiInput

-

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

+

Optional decryptionKey

decryptionKey?: string

Memberof

ZixiInput

+

Optional decryptionType

decryptionType?: string

Memberof

ZixiInput

+

Optional description

description?: string

Description of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional host

host?: string

Memberof

ZixiInput

-

Optional id

id?: string

Id of the resource (required)

+

Optional host

host?: string

Memberof

ZixiInput

+

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

-

Optional latency

latency?: number

Memberof

ZixiInput

-

Optional minBitrate

minBitrate?: number

Memberof

ZixiInput

-

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

+

Optional latency

latency?: number

Memberof

ZixiInput

+

Optional minBitrate

minBitrate?: number

Memberof

ZixiInput

+

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

-

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

+

Optional name

name?: string

Name of the resource. Can be freely chosen by the user.

Memberof

BitmovinResource

-

Optional password

password?: string

Memberof

ZixiInput

-

Optional port

port?: number

Memberof

ZixiInput

-

Optional stream

stream?: string

Memberof

ZixiInput

-

Readonly type

type: InputType = InputType.ZIXI

Discriminator property for Input

+

Optional password

password?: string

Memberof

ZixiInput

+

Optional port

port?: number

Memberof

ZixiInput

+

Optional stream

stream?: string

Memberof

ZixiInput

+

Readonly type

type: InputType = InputType.ZIXI

Discriminator property for Input

Memberof

ZixiInput

-

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

  • AKAMAI_NETSTORAGE: string
  • ASPERA: string
  • AZURE: string
  • DIRECT_FILE_UPLOAD: string
  • FTP: string
  • GCS: string
  • GCS_SERVICE_ACCOUNT: string
  • GENERIC_S3: string
  • HTTP: string
  • HTTPS: string
  • LOCAL: string
  • REDUNDANT_RTMP: string
  • RTMP: string
  • S3: string
  • S3_ROLE_BASED: string
  • SFTP: string
  • SRT: string
  • ZIXI: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadecryptionKeydecryptionTypedescriptionhostidlatencyminBitratemodifiedAtnamepasswordportstreamtype_discriminatorMapping_discriminatorName
\ No newline at end of file +

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AKAMAI_NETSTORAGE: string;
    ASPERA: string;
    AZURE: string;
    DIRECT_FILE_UPLOAD: string;
    FTP: string;
    GCS: string;
    GCS_SERVICE_ACCOUNT: string;
    GENERIC_S3: string;
    HTTP: string;
    HTTPS: string;
    LOCAL: string;
    REDUNDANT_RTMP: string;
    RTMP: string;
    S3: string;
    S3_ROLE_BASED: string;
    SFTP: string;
    SRT: string;
    ZIXI: string;
} = ...

Type declaration

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadecryptionKeydecryptionTypedescriptionhostidlatencyminBitratemodifiedAtnamepasswordportstreamtype_discriminatorMapping_discriminatorName
\ No newline at end of file diff --git a/docs/classes/default.html b/docs/classes/default.html index 0be487b35..983ac9364 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -1,6 +1,6 @@ default | @bitmovin/api-sdk

Class default

BitmovinApi - object-oriented interface

Export

BitmovinApi

-

Hierarchy

  • BaseAPI
    • default

Constructors

constructor +

Hierarchy

  • BaseAPI
    • default

Constructors

constructor

Properties

account analytics encoding @@ -9,4 +9,4 @@ player restClient streams -

Constructors

constructor

Properties

account

account: default

analytics

analytics: default

encoding

encoding: default

general

general: default

notifications

notifications: default

player

player: default

Protected restClient

restClient: RestClient

streams

streams: default

Settings

Member Visibility

Theme

On This Page

constructoraccountanalyticsencodinggeneralnotificationsplayerrestClientstreams
\ No newline at end of file +

Constructors

constructor

Properties

account

account: default

analytics

analytics: default

encoding

encoding: default

general

general: default

notifications

notifications: default

player

player: default

Protected restClient

restClient: RestClient

streams

streams: default

Settings

Member Visibility

Theme

On This Page

constructoraccountanalyticsencodinggeneralnotificationsplayerrestClientstreams
\ No newline at end of file diff --git a/docs/enums/AacChannelLayout.html b/docs/enums/AacChannelLayout.html index faac72ef2..906f9f848 100644 --- a/docs/enums/AacChannelLayout.html +++ b/docs/enums/AacChannelLayout.html @@ -1,4 +1,4 @@ -AacChannelLayout | @bitmovin/api-sdk

Enumeration AacChannelLayout

Export

Enumeration Members

CL_4_0 +AacChannelLayout | @bitmovin/api-sdk

Enumeration AacChannelLayout

Export

Enumeration Members

CL_4_0 CL_5_0_BACK CL_5_1_BACK CL_7_1 @@ -7,4 +7,4 @@ CL_SURROUND MONO NONE -

Enumeration Members

CL_4_0

CL_4_0: "4.0"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_7_1

CL_7_1: "7.1"

CL_7_1_WIDE_BACK

CL_7_1_WIDE_BACK: "7.1_WIDE_BACK"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_4_0CL_5_0_BACKCL_5_1_BACKCL_7_1CL_7_1_WIDE_BACKCL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file +

Enumeration Members

CL_4_0

CL_4_0: "4.0"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_7_1

CL_7_1: "7.1"

CL_7_1_WIDE_BACK

CL_7_1_WIDE_BACK: "7.1_WIDE_BACK"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_4_0CL_5_0_BACKCL_5_1_BACKCL_7_1CL_7_1_WIDE_BACKCL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file diff --git a/docs/enums/Ac3ChannelLayout.html b/docs/enums/Ac3ChannelLayout.html index 2052b9792..6d82efee0 100644 --- a/docs/enums/Ac3ChannelLayout.html +++ b/docs/enums/Ac3ChannelLayout.html @@ -1,4 +1,4 @@ -Ac3ChannelLayout | @bitmovin/api-sdk

Enumeration Ac3ChannelLayout

Export

Enumeration Members

CL_2_1 +Ac3ChannelLayout | @bitmovin/api-sdk

Enumeration Ac3ChannelLayout

Export

Enumeration Members

CL_2_1 CL_2_2 CL_3_1 CL_4_0 @@ -12,4 +12,4 @@ CL_SURROUND MONO NONE -

Enumeration Members

CL_2_1

CL_2_1: "2.1"

CL_2_2

CL_2_2: "2.2"

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_5_1

CL_5_1: "5.1"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_2_1CL_2_2CL_3_1CL_4_0CL_4_1CL_5_0CL_5_0_BACKCL_5_1CL_5_1_BACKCL_QUADCL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file +

Enumeration Members

CL_2_1

CL_2_1: "2.1"

CL_2_2

CL_2_2: "2.2"

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_5_1

CL_5_1: "5.1"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_2_1CL_2_2CL_3_1CL_4_0CL_4_1CL_5_0CL_5_0_BACKCL_5_1CL_5_1_BACKCL_QUADCL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file diff --git a/docs/enums/AclPermission.html b/docs/enums/AclPermission.html index ef8c2bb86..50104f2b8 100644 --- a/docs/enums/AclPermission.html +++ b/docs/enums/AclPermission.html @@ -1,3 +1,3 @@ -AclPermission | @bitmovin/api-sdk

Enumeration AclPermission

Export

Enumeration Members

PRIVATE +AclPermission | @bitmovin/api-sdk

Enumeration AclPermission

Export

Enumeration Members

PRIVATE PUBLIC_READ -

Enumeration Members

PRIVATE

PRIVATE: "PRIVATE"

PUBLIC_READ

PUBLIC_READ: "PUBLIC_READ"

Settings

Member Visibility

Theme

On This Page

PRIVATEPUBLIC_READ
\ No newline at end of file +

Enumeration Members

PRIVATE

PRIVATE: "PRIVATE"

PUBLIC_READ

PUBLIC_READ: "PUBLIC_READ"

Settings

Member Visibility

Theme

On This Page

PRIVATEPUBLIC_READ
\ No newline at end of file diff --git a/docs/enums/AdAnalyticsAttribute.html b/docs/enums/AdAnalyticsAttribute.html index 2ab8bc3ab..198f936a8 100644 --- a/docs/enums/AdAnalyticsAttribute.html +++ b/docs/enums/AdAnalyticsAttribute.html @@ -1,4 +1,4 @@ -AdAnalyticsAttribute | @bitmovin/api-sdk

Enumeration AdAnalyticsAttribute

Export

Enumeration Members

ADVERTISER_NAME +AdAnalyticsAttribute | @bitmovin/api-sdk

Enumeration AdAnalyticsAttribute

Export

Enumeration Members

ADVERTISER_NAME AD_CLICKTHROUGH_URL AD_DESCRIPTION AD_DURATION @@ -141,4 +141,4 @@ VIDEO_TITLE VIDEO_WINDOW_HEIGHT VIDEO_WINDOW_WIDTH -

Enumeration Members

ADVERTISER_NAME

ADVERTISER_NAME: "ADVERTISER_NAME"

AD_CLICKTHROUGH_URL

AD_CLICKTHROUGH_URL: "AD_CLICKTHROUGH_URL"

AD_DESCRIPTION

AD_DESCRIPTION: "AD_DESCRIPTION"

AD_DURATION

AD_DURATION: "AD_DURATION"

AD_FALLBACK_INDEX

AD_FALLBACK_INDEX: "AD_FALLBACK_INDEX"

AD_ID

AD_ID: "AD_ID"

AD_ID_PLAYER

AD_ID_PLAYER: "AD_ID_PLAYER"

AD_IMPRESSION_ID

AD_IMPRESSION_ID: "AD_IMPRESSION_ID"

AD_IS_PERSISTENT

AD_IS_PERSISTENT: "AD_IS_PERSISTENT"

AD_MODULE

AD_MODULE: "AD_MODULE"

AD_OFFSET

AD_OFFSET: "AD_OFFSET"

AD_PLAYBACK_HEIGHT

AD_PLAYBACK_HEIGHT: "AD_PLAYBACK_HEIGHT"

AD_PLAYBACK_WIDTH

AD_PLAYBACK_WIDTH: "AD_PLAYBACK_WIDTH"

AD_POD_POSITION

AD_POD_POSITION: "AD_POD_POSITION"

AD_POSITION

AD_POSITION: "AD_POSITION"

AD_PRELOAD_OFFSET

AD_PRELOAD_OFFSET: "AD_PRELOAD_OFFSET"

AD_REPLACE_CONTENT_DURATION

AD_REPLACE_CONTENT_DURATION: "AD_REPLACE_CONTENT_DURATION"

AD_SCHEDULE_TIME

AD_SCHEDULE_TIME: "AD_SCHEDULE_TIME"

AD_SKIPPABLE

AD_SKIPPABLE: "AD_SKIPPABLE"

AD_SKIP_AFTER

AD_SKIP_AFTER: "AD_SKIP_AFTER"

AD_STARTUP_TIME

AD_STARTUP_TIME: "AD_STARTUP_TIME"

AD_SYSTEM

AD_SYSTEM: "AD_SYSTEM"

AD_TAG_PATH

AD_TAG_PATH: "AD_TAG_PATH"

AD_TAG_SERVER

AD_TAG_SERVER: "AD_TAG_SERVER"

AD_TAG_TYPE

AD_TAG_TYPE: "AD_TAG_TYPE"

AD_TAG_URL

AD_TAG_URL: "AD_TAG_URL"

AD_TITLE

AD_TITLE: "AD_TITLE"

AD_WRAPPER_ADS_COUNT

AD_WRAPPER_ADS_COUNT: "AD_WRAPPER_ADS_COUNT"

ANALYTICS_VERSION

ANALYTICS_VERSION: "ANALYTICS_VERSION"

API_FRAMEWORK

API_FRAMEWORK: "API_FRAMEWORK"

AUDIO_BITRATE

AUDIO_BITRATE: "AUDIO_BITRATE"

AUDIO_CODEC

AUDIO_CODEC: "AUDIO_CODEC"

AUTOPLAY

AUTOPLAY: "AUTOPLAY"

BROWSER

BROWSER: "BROWSER"

BROWSER_VERSION_MAJOR

BROWSER_VERSION_MAJOR: "BROWSER_VERSION_MAJOR"

CDN_PROVIDER

CDN_PROVIDER: "CDN_PROVIDER"

CITY

CITY: "CITY"

CLICKED

CLICKED: "CLICKED"

CLICK_PERCENTAGE

CLICK_PERCENTAGE: "CLICK_PERCENTAGE"

CLICK_POSITION

CLICK_POSITION: "CLICK_POSITION"

CLIENT_TIME

CLIENT_TIME: "CLIENT_TIME"

CLOSED

CLOSED: "CLOSED"

CLOSE_PERCENTAGE

CLOSE_PERCENTAGE: "CLOSE_PERCENTAGE"

CLOSE_POSITION

CLOSE_POSITION: "CLOSE_POSITION"

COMPLETED

COMPLETED: "COMPLETED"

COUNTRY

COUNTRY: "COUNTRY"

CREATIVE_AD_ID

CREATIVE_AD_ID: "CREATIVE_AD_ID"

CREATIVE_ID

CREATIVE_ID: "CREATIVE_ID"

CUSTOM_DATA_1

CUSTOM_DATA_1: "CUSTOM_DATA_1"

CUSTOM_DATA_10

CUSTOM_DATA_10: "CUSTOM_DATA_10"

CUSTOM_DATA_11

CUSTOM_DATA_11: "CUSTOM_DATA_11"

CUSTOM_DATA_12

CUSTOM_DATA_12: "CUSTOM_DATA_12"

CUSTOM_DATA_13

CUSTOM_DATA_13: "CUSTOM_DATA_13"

CUSTOM_DATA_14

CUSTOM_DATA_14: "CUSTOM_DATA_14"

CUSTOM_DATA_15

CUSTOM_DATA_15: "CUSTOM_DATA_15"

CUSTOM_DATA_16

CUSTOM_DATA_16: "CUSTOM_DATA_16"

CUSTOM_DATA_17

CUSTOM_DATA_17: "CUSTOM_DATA_17"

CUSTOM_DATA_18

CUSTOM_DATA_18: "CUSTOM_DATA_18"

CUSTOM_DATA_19

CUSTOM_DATA_19: "CUSTOM_DATA_19"

CUSTOM_DATA_2

CUSTOM_DATA_2: "CUSTOM_DATA_2"

CUSTOM_DATA_20

CUSTOM_DATA_20: "CUSTOM_DATA_20"

CUSTOM_DATA_21

CUSTOM_DATA_21: "CUSTOM_DATA_21"

CUSTOM_DATA_22

CUSTOM_DATA_22: "CUSTOM_DATA_22"

CUSTOM_DATA_23

CUSTOM_DATA_23: "CUSTOM_DATA_23"

CUSTOM_DATA_24

CUSTOM_DATA_24: "CUSTOM_DATA_24"

CUSTOM_DATA_25

CUSTOM_DATA_25: "CUSTOM_DATA_25"

CUSTOM_DATA_26

CUSTOM_DATA_26: "CUSTOM_DATA_26"

CUSTOM_DATA_27

CUSTOM_DATA_27: "CUSTOM_DATA_27"

CUSTOM_DATA_28

CUSTOM_DATA_28: "CUSTOM_DATA_28"

CUSTOM_DATA_29

CUSTOM_DATA_29: "CUSTOM_DATA_29"

CUSTOM_DATA_3

CUSTOM_DATA_3: "CUSTOM_DATA_3"

CUSTOM_DATA_30

CUSTOM_DATA_30: "CUSTOM_DATA_30"

CUSTOM_DATA_4

CUSTOM_DATA_4: "CUSTOM_DATA_4"

CUSTOM_DATA_5

CUSTOM_DATA_5: "CUSTOM_DATA_5"

CUSTOM_DATA_6

CUSTOM_DATA_6: "CUSTOM_DATA_6"

CUSTOM_DATA_7

CUSTOM_DATA_7: "CUSTOM_DATA_7"

CUSTOM_DATA_8

CUSTOM_DATA_8: "CUSTOM_DATA_8"

CUSTOM_DATA_9

CUSTOM_DATA_9: "CUSTOM_DATA_9"

CUSTOM_USER_ID

CUSTOM_USER_ID: "CUSTOM_USER_ID"

DAY

DAY: "DAY"

DEAL_ID

DEAL_ID: "DEAL_ID"

DEVICE_CLASS

DEVICE_CLASS: "DEVICE_CLASS"

DEVICE_TYPE

DEVICE_TYPE: "DEVICE_TYPE"

DOMAIN

DOMAIN: "DOMAIN"

ERROR_CODE

ERROR_CODE: "ERROR_CODE"

ERROR_PERCENTAGE

ERROR_PERCENTAGE: "ERROR_PERCENTAGE"

ERROR_POSITION

ERROR_POSITION: "ERROR_POSITION"

EXIT_POSITION

EXIT_POSITION: "EXIT_POSITION"

EXPERIMENT_NAME

EXPERIMENT_NAME: "EXPERIMENT_NAME"

HOUR

HOUR: "HOUR"

IP_ADDRESS

IP_ADDRESS: "IP_ADDRESS"

ISP

ISP: "ISP"

IS_LINEAR

IS_LINEAR: "IS_LINEAR"

LANGUAGE

LANGUAGE: "LANGUAGE"

LICENSE_KEY

LICENSE_KEY: "LICENSE_KEY"

MANIFEST_DOWNLOAD_TIME

MANIFEST_DOWNLOAD_TIME: "MANIFEST_DOWNLOAD_TIME"

MEDIA_PATH

MEDIA_PATH: "MEDIA_PATH"

MEDIA_SERVER

MEDIA_SERVER: "MEDIA_SERVER"

MEDIA_URL

MEDIA_URL: "MEDIA_URL"

MIDPOINT

MIDPOINT: "MIDPOINT"

MINUTE

MINUTE: "MINUTE"

MIN_SUGGESTED_DURATION

MIN_SUGGESTED_DURATION: "MIN_SUGGESTED_DURATION"

MONTH

MONTH: "MONTH"

OPERATINGSYSTEM

OPERATINGSYSTEM: "OPERATINGSYSTEM"

OPERATINGSYSTEM_VERSION_MAJOR

OPERATINGSYSTEM_VERSION_MAJOR: "OPERATINGSYSTEM_VERSION_MAJOR"

PAGE_LOAD_TIME

PAGE_LOAD_TIME: "PAGE_LOAD_TIME"

PAGE_LOAD_TYPE

PAGE_LOAD_TYPE: "PAGE_LOAD_TYPE"

PATH

PATH: "PATH"

PERCENTAGE_IN_VIEWPORT

PERCENTAGE_IN_VIEWPORT: "PERCENTAGE_IN_VIEWPORT"

PLATFORM

PLATFORM: "PLATFORM"

PLAYER

PLAYER: "PLAYER"

PLAYER_KEY

PLAYER_KEY: "PLAYER_KEY"

PLAYER_STARTUPTIME

PLAYER_STARTUPTIME: "PLAYER_STARTUPTIME"

PLAYER_TECH

PLAYER_TECH: "PLAYER_TECH"

PLAYER_VERSION

PLAYER_VERSION: "PLAYER_VERSION"

PLAY_PERCENTAGE

PLAY_PERCENTAGE: "PLAY_PERCENTAGE"

QUARTILE_1

QUARTILE_1: "QUARTILE_1"

QUARTILE_3

QUARTILE_3: "QUARTILE_3"

REGION

REGION: "REGION"

SCALE_FACTOR

SCALE_FACTOR: "SCALE_FACTOR"

SCREEN_HEIGHT

SCREEN_HEIGHT: "SCREEN_HEIGHT"

SCREEN_ORIENTATION

SCREEN_ORIENTATION: "SCREEN_ORIENTATION"

SCREEN_WIDTH

SCREEN_WIDTH: "SCREEN_WIDTH"

SIZE

SIZE: "SIZE"

SKIPPED

SKIPPED: "SKIPPED"

SKIP_PERCENTAGE

SKIP_PERCENTAGE: "SKIP_PERCENTAGE"

SKIP_POSITION

SKIP_POSITION: "SKIP_POSITION"

STARTED

STARTED: "STARTED"

STREAM_FORMAT

STREAM_FORMAT: "STREAM_FORMAT"

SURVEY_URL

SURVEY_URL: "SURVEY_URL"

TIME

TIME: "TIME"

TIME_IN_VIEWPORT

TIME_IN_VIEWPORT: "TIME_IN_VIEWPORT"

TIME_PLAYED

TIME_PLAYED: "TIME_PLAYED"

UNIVERSAL_AD_ID_REGISTRY

UNIVERSAL_AD_ID_REGISTRY: "UNIVERSAL_AD_ID_REGISTRY"

UNIVERSAL_AD_ID_VALUE

UNIVERSAL_AD_ID_VALUE: "UNIVERSAL_AD_ID_VALUE"

USER_ID

USER_ID: "USER_ID"

VIDEO_BITRATE

VIDEO_BITRATE: "VIDEO_BITRATE"

VIDEO_CODEC

VIDEO_CODEC: "VIDEO_CODEC"

VIDEO_ID

VIDEO_ID: "VIDEO_ID"

VIDEO_IMPRESSION_ID

VIDEO_IMPRESSION_ID: "VIDEO_IMPRESSION_ID"

VIDEO_TITLE

VIDEO_TITLE: "VIDEO_TITLE"

VIDEO_WINDOW_HEIGHT

VIDEO_WINDOW_HEIGHT: "VIDEO_WINDOW_HEIGHT"

VIDEO_WINDOW_WIDTH

VIDEO_WINDOW_WIDTH: "VIDEO_WINDOW_WIDTH"

Settings

Member Visibility

Theme

On This Page

ADVERTISER_NAMEAD_CLICKTHROUGH_URLAD_DESCRIPTIONAD_DURATIONAD_FALLBACK_INDEXAD_IDAD_ID_PLAYERAD_IMPRESSION_IDAD_IS_PERSISTENTAD_MODULEAD_OFFSETAD_PLAYBACK_HEIGHTAD_PLAYBACK_WIDTHAD_POD_POSITIONAD_POSITIONAD_PRELOAD_OFFSETAD_REPLACE_CONTENT_DURATIONAD_SCHEDULE_TIMEAD_SKIPPABLEAD_SKIP_AFTERAD_STARTUP_TIMEAD_SYSTEMAD_TAG_PATHAD_TAG_SERVERAD_TAG_TYPEAD_TAG_URLAD_TITLEAD_WRAPPER_ADS_COUNTANALYTICS_VERSIONAPI_FRAMEWORKAUDIO_BITRATEAUDIO_CODECAUTOPLAYBROWSERBROWSER_VERSION_MAJORCDN_PROVIDERCITYCLICKEDCLICK_PERCENTAGECLICK_POSITIONCLIENT_TIMECLOSEDCLOSE_PERCENTAGECLOSE_POSITIONCOMPLETEDCOUNTRYCREATIVE_AD_IDCREATIVE_IDCUSTOM_DATA_1CUSTOM_DATA_10CUSTOM_DATA_11CUSTOM_DATA_12CUSTOM_DATA_13CUSTOM_DATA_14CUSTOM_DATA_15CUSTOM_DATA_16CUSTOM_DATA_17CUSTOM_DATA_18CUSTOM_DATA_19CUSTOM_DATA_2CUSTOM_DATA_20CUSTOM_DATA_21CUSTOM_DATA_22CUSTOM_DATA_23CUSTOM_DATA_24CUSTOM_DATA_25CUSTOM_DATA_26CUSTOM_DATA_27CUSTOM_DATA_28CUSTOM_DATA_29CUSTOM_DATA_3CUSTOM_DATA_30CUSTOM_DATA_4CUSTOM_DATA_5CUSTOM_DATA_6CUSTOM_DATA_7CUSTOM_DATA_8CUSTOM_DATA_9CUSTOM_USER_IDDAYDEAL_IDDEVICE_CLASSDEVICE_TYPEDOMAINERROR_CODEERROR_PERCENTAGEERROR_POSITIONEXIT_POSITIONEXPERIMENT_NAMEHOURIP_ADDRESSISPIS_LINEARLANGUAGELICENSE_KEYMANIFEST_DOWNLOAD_TIMEMEDIA_PATHMEDIA_SERVERMEDIA_URLMIDPOINTMINUTEMIN_SUGGESTED_DURATIONMONTHOPERATINGSYSTEMOPERATINGSYSTEM_VERSION_MAJORPAGE_LOAD_TIMEPAGE_LOAD_TYPEPATHPERCENTAGE_IN_VIEWPORTPLATFORMPLAYERPLAYER_KEYPLAYER_STARTUPTIMEPLAYER_TECHPLAYER_VERSIONPLAY_PERCENTAGEQUARTILE_1QUARTILE_3REGIONSCALE_FACTORSCREEN_HEIGHTSCREEN_ORIENTATIONSCREEN_WIDTHSIZESKIPPEDSKIP_PERCENTAGESKIP_POSITIONSTARTEDSTREAM_FORMATSURVEY_URLTIMETIME_IN_VIEWPORTTIME_PLAYEDUNIVERSAL_AD_ID_REGISTRYUNIVERSAL_AD_ID_VALUEUSER_IDVIDEO_BITRATEVIDEO_CODECVIDEO_IDVIDEO_IMPRESSION_IDVIDEO_TITLEVIDEO_WINDOW_HEIGHTVIDEO_WINDOW_WIDTH
\ No newline at end of file +

Enumeration Members

ADVERTISER_NAME

ADVERTISER_NAME: "ADVERTISER_NAME"

AD_CLICKTHROUGH_URL

AD_CLICKTHROUGH_URL: "AD_CLICKTHROUGH_URL"

AD_DESCRIPTION

AD_DESCRIPTION: "AD_DESCRIPTION"

AD_DURATION

AD_DURATION: "AD_DURATION"

AD_FALLBACK_INDEX

AD_FALLBACK_INDEX: "AD_FALLBACK_INDEX"

AD_ID

AD_ID: "AD_ID"

AD_ID_PLAYER

AD_ID_PLAYER: "AD_ID_PLAYER"

AD_IMPRESSION_ID

AD_IMPRESSION_ID: "AD_IMPRESSION_ID"

AD_IS_PERSISTENT

AD_IS_PERSISTENT: "AD_IS_PERSISTENT"

AD_MODULE

AD_MODULE: "AD_MODULE"

AD_OFFSET

AD_OFFSET: "AD_OFFSET"

AD_PLAYBACK_HEIGHT

AD_PLAYBACK_HEIGHT: "AD_PLAYBACK_HEIGHT"

AD_PLAYBACK_WIDTH

AD_PLAYBACK_WIDTH: "AD_PLAYBACK_WIDTH"

AD_POD_POSITION

AD_POD_POSITION: "AD_POD_POSITION"

AD_POSITION

AD_POSITION: "AD_POSITION"

AD_PRELOAD_OFFSET

AD_PRELOAD_OFFSET: "AD_PRELOAD_OFFSET"

AD_REPLACE_CONTENT_DURATION

AD_REPLACE_CONTENT_DURATION: "AD_REPLACE_CONTENT_DURATION"

AD_SCHEDULE_TIME

AD_SCHEDULE_TIME: "AD_SCHEDULE_TIME"

AD_SKIPPABLE

AD_SKIPPABLE: "AD_SKIPPABLE"

AD_SKIP_AFTER

AD_SKIP_AFTER: "AD_SKIP_AFTER"

AD_STARTUP_TIME

AD_STARTUP_TIME: "AD_STARTUP_TIME"

AD_SYSTEM

AD_SYSTEM: "AD_SYSTEM"

AD_TAG_PATH

AD_TAG_PATH: "AD_TAG_PATH"

AD_TAG_SERVER

AD_TAG_SERVER: "AD_TAG_SERVER"

AD_TAG_TYPE

AD_TAG_TYPE: "AD_TAG_TYPE"

AD_TAG_URL

AD_TAG_URL: "AD_TAG_URL"

AD_TITLE

AD_TITLE: "AD_TITLE"

AD_WRAPPER_ADS_COUNT

AD_WRAPPER_ADS_COUNT: "AD_WRAPPER_ADS_COUNT"

ANALYTICS_VERSION

ANALYTICS_VERSION: "ANALYTICS_VERSION"

API_FRAMEWORK

API_FRAMEWORK: "API_FRAMEWORK"

AUDIO_BITRATE

AUDIO_BITRATE: "AUDIO_BITRATE"

AUDIO_CODEC

AUDIO_CODEC: "AUDIO_CODEC"

AUTOPLAY

AUTOPLAY: "AUTOPLAY"

BROWSER

BROWSER: "BROWSER"

BROWSER_VERSION_MAJOR

BROWSER_VERSION_MAJOR: "BROWSER_VERSION_MAJOR"

CDN_PROVIDER

CDN_PROVIDER: "CDN_PROVIDER"

CITY

CITY: "CITY"

CLICKED

CLICKED: "CLICKED"

CLICK_PERCENTAGE

CLICK_PERCENTAGE: "CLICK_PERCENTAGE"

CLICK_POSITION

CLICK_POSITION: "CLICK_POSITION"

CLIENT_TIME

CLIENT_TIME: "CLIENT_TIME"

CLOSED

CLOSED: "CLOSED"

CLOSE_PERCENTAGE

CLOSE_PERCENTAGE: "CLOSE_PERCENTAGE"

CLOSE_POSITION

CLOSE_POSITION: "CLOSE_POSITION"

COMPLETED

COMPLETED: "COMPLETED"

COUNTRY

COUNTRY: "COUNTRY"

CREATIVE_AD_ID

CREATIVE_AD_ID: "CREATIVE_AD_ID"

CREATIVE_ID

CREATIVE_ID: "CREATIVE_ID"

CUSTOM_DATA_1

CUSTOM_DATA_1: "CUSTOM_DATA_1"

CUSTOM_DATA_10

CUSTOM_DATA_10: "CUSTOM_DATA_10"

CUSTOM_DATA_11

CUSTOM_DATA_11: "CUSTOM_DATA_11"

CUSTOM_DATA_12

CUSTOM_DATA_12: "CUSTOM_DATA_12"

CUSTOM_DATA_13

CUSTOM_DATA_13: "CUSTOM_DATA_13"

CUSTOM_DATA_14

CUSTOM_DATA_14: "CUSTOM_DATA_14"

CUSTOM_DATA_15

CUSTOM_DATA_15: "CUSTOM_DATA_15"

CUSTOM_DATA_16

CUSTOM_DATA_16: "CUSTOM_DATA_16"

CUSTOM_DATA_17

CUSTOM_DATA_17: "CUSTOM_DATA_17"

CUSTOM_DATA_18

CUSTOM_DATA_18: "CUSTOM_DATA_18"

CUSTOM_DATA_19

CUSTOM_DATA_19: "CUSTOM_DATA_19"

CUSTOM_DATA_2

CUSTOM_DATA_2: "CUSTOM_DATA_2"

CUSTOM_DATA_20

CUSTOM_DATA_20: "CUSTOM_DATA_20"

CUSTOM_DATA_21

CUSTOM_DATA_21: "CUSTOM_DATA_21"

CUSTOM_DATA_22

CUSTOM_DATA_22: "CUSTOM_DATA_22"

CUSTOM_DATA_23

CUSTOM_DATA_23: "CUSTOM_DATA_23"

CUSTOM_DATA_24

CUSTOM_DATA_24: "CUSTOM_DATA_24"

CUSTOM_DATA_25

CUSTOM_DATA_25: "CUSTOM_DATA_25"

CUSTOM_DATA_26

CUSTOM_DATA_26: "CUSTOM_DATA_26"

CUSTOM_DATA_27

CUSTOM_DATA_27: "CUSTOM_DATA_27"

CUSTOM_DATA_28

CUSTOM_DATA_28: "CUSTOM_DATA_28"

CUSTOM_DATA_29

CUSTOM_DATA_29: "CUSTOM_DATA_29"

CUSTOM_DATA_3

CUSTOM_DATA_3: "CUSTOM_DATA_3"

CUSTOM_DATA_30

CUSTOM_DATA_30: "CUSTOM_DATA_30"

CUSTOM_DATA_4

CUSTOM_DATA_4: "CUSTOM_DATA_4"

CUSTOM_DATA_5

CUSTOM_DATA_5: "CUSTOM_DATA_5"

CUSTOM_DATA_6

CUSTOM_DATA_6: "CUSTOM_DATA_6"

CUSTOM_DATA_7

CUSTOM_DATA_7: "CUSTOM_DATA_7"

CUSTOM_DATA_8

CUSTOM_DATA_8: "CUSTOM_DATA_8"

CUSTOM_DATA_9

CUSTOM_DATA_9: "CUSTOM_DATA_9"

CUSTOM_USER_ID

CUSTOM_USER_ID: "CUSTOM_USER_ID"

DAY

DAY: "DAY"

DEAL_ID

DEAL_ID: "DEAL_ID"

DEVICE_CLASS

DEVICE_CLASS: "DEVICE_CLASS"

DEVICE_TYPE

DEVICE_TYPE: "DEVICE_TYPE"

DOMAIN

DOMAIN: "DOMAIN"

ERROR_CODE

ERROR_CODE: "ERROR_CODE"

ERROR_PERCENTAGE

ERROR_PERCENTAGE: "ERROR_PERCENTAGE"

ERROR_POSITION

ERROR_POSITION: "ERROR_POSITION"

EXIT_POSITION

EXIT_POSITION: "EXIT_POSITION"

EXPERIMENT_NAME

EXPERIMENT_NAME: "EXPERIMENT_NAME"

HOUR

HOUR: "HOUR"

IP_ADDRESS

IP_ADDRESS: "IP_ADDRESS"

ISP

ISP: "ISP"

IS_LINEAR

IS_LINEAR: "IS_LINEAR"

LANGUAGE

LANGUAGE: "LANGUAGE"

LICENSE_KEY

LICENSE_KEY: "LICENSE_KEY"

MANIFEST_DOWNLOAD_TIME

MANIFEST_DOWNLOAD_TIME: "MANIFEST_DOWNLOAD_TIME"

MEDIA_PATH

MEDIA_PATH: "MEDIA_PATH"

MEDIA_SERVER

MEDIA_SERVER: "MEDIA_SERVER"

MEDIA_URL

MEDIA_URL: "MEDIA_URL"

MIDPOINT

MIDPOINT: "MIDPOINT"

MINUTE

MINUTE: "MINUTE"

MIN_SUGGESTED_DURATION

MIN_SUGGESTED_DURATION: "MIN_SUGGESTED_DURATION"

MONTH

MONTH: "MONTH"

OPERATINGSYSTEM

OPERATINGSYSTEM: "OPERATINGSYSTEM"

OPERATINGSYSTEM_VERSION_MAJOR

OPERATINGSYSTEM_VERSION_MAJOR: "OPERATINGSYSTEM_VERSION_MAJOR"

PAGE_LOAD_TIME

PAGE_LOAD_TIME: "PAGE_LOAD_TIME"

PAGE_LOAD_TYPE

PAGE_LOAD_TYPE: "PAGE_LOAD_TYPE"

PATH

PATH: "PATH"

PERCENTAGE_IN_VIEWPORT

PERCENTAGE_IN_VIEWPORT: "PERCENTAGE_IN_VIEWPORT"

PLATFORM

PLATFORM: "PLATFORM"

PLAYER

PLAYER: "PLAYER"

PLAYER_KEY

PLAYER_KEY: "PLAYER_KEY"

PLAYER_STARTUPTIME

PLAYER_STARTUPTIME: "PLAYER_STARTUPTIME"

PLAYER_TECH

PLAYER_TECH: "PLAYER_TECH"

PLAYER_VERSION

PLAYER_VERSION: "PLAYER_VERSION"

PLAY_PERCENTAGE

PLAY_PERCENTAGE: "PLAY_PERCENTAGE"

QUARTILE_1

QUARTILE_1: "QUARTILE_1"

QUARTILE_3

QUARTILE_3: "QUARTILE_3"

REGION

REGION: "REGION"

SCALE_FACTOR

SCALE_FACTOR: "SCALE_FACTOR"

SCREEN_HEIGHT

SCREEN_HEIGHT: "SCREEN_HEIGHT"

SCREEN_ORIENTATION

SCREEN_ORIENTATION: "SCREEN_ORIENTATION"

SCREEN_WIDTH

SCREEN_WIDTH: "SCREEN_WIDTH"

SIZE

SIZE: "SIZE"

SKIPPED

SKIPPED: "SKIPPED"

SKIP_PERCENTAGE

SKIP_PERCENTAGE: "SKIP_PERCENTAGE"

SKIP_POSITION

SKIP_POSITION: "SKIP_POSITION"

STARTED

STARTED: "STARTED"

STREAM_FORMAT

STREAM_FORMAT: "STREAM_FORMAT"

SURVEY_URL

SURVEY_URL: "SURVEY_URL"

TIME

TIME: "TIME"

TIME_IN_VIEWPORT

TIME_IN_VIEWPORT: "TIME_IN_VIEWPORT"

TIME_PLAYED

TIME_PLAYED: "TIME_PLAYED"

UNIVERSAL_AD_ID_REGISTRY

UNIVERSAL_AD_ID_REGISTRY: "UNIVERSAL_AD_ID_REGISTRY"

UNIVERSAL_AD_ID_VALUE

UNIVERSAL_AD_ID_VALUE: "UNIVERSAL_AD_ID_VALUE"

USER_ID

USER_ID: "USER_ID"

VIDEO_BITRATE

VIDEO_BITRATE: "VIDEO_BITRATE"

VIDEO_CODEC

VIDEO_CODEC: "VIDEO_CODEC"

VIDEO_ID

VIDEO_ID: "VIDEO_ID"

VIDEO_IMPRESSION_ID

VIDEO_IMPRESSION_ID: "VIDEO_IMPRESSION_ID"

VIDEO_TITLE

VIDEO_TITLE: "VIDEO_TITLE"

VIDEO_WINDOW_HEIGHT

VIDEO_WINDOW_HEIGHT: "VIDEO_WINDOW_HEIGHT"

VIDEO_WINDOW_WIDTH

VIDEO_WINDOW_WIDTH: "VIDEO_WINDOW_WIDTH"

Settings

Member Visibility

Theme

On This Page

ADVERTISER_NAMEAD_CLICKTHROUGH_URLAD_DESCRIPTIONAD_DURATIONAD_FALLBACK_INDEXAD_IDAD_ID_PLAYERAD_IMPRESSION_IDAD_IS_PERSISTENTAD_MODULEAD_OFFSETAD_PLAYBACK_HEIGHTAD_PLAYBACK_WIDTHAD_POD_POSITIONAD_POSITIONAD_PRELOAD_OFFSETAD_REPLACE_CONTENT_DURATIONAD_SCHEDULE_TIMEAD_SKIPPABLEAD_SKIP_AFTERAD_STARTUP_TIMEAD_SYSTEMAD_TAG_PATHAD_TAG_SERVERAD_TAG_TYPEAD_TAG_URLAD_TITLEAD_WRAPPER_ADS_COUNTANALYTICS_VERSIONAPI_FRAMEWORKAUDIO_BITRATEAUDIO_CODECAUTOPLAYBROWSERBROWSER_VERSION_MAJORCDN_PROVIDERCITYCLICKEDCLICK_PERCENTAGECLICK_POSITIONCLIENT_TIMECLOSEDCLOSE_PERCENTAGECLOSE_POSITIONCOMPLETEDCOUNTRYCREATIVE_AD_IDCREATIVE_IDCUSTOM_DATA_1CUSTOM_DATA_10CUSTOM_DATA_11CUSTOM_DATA_12CUSTOM_DATA_13CUSTOM_DATA_14CUSTOM_DATA_15CUSTOM_DATA_16CUSTOM_DATA_17CUSTOM_DATA_18CUSTOM_DATA_19CUSTOM_DATA_2CUSTOM_DATA_20CUSTOM_DATA_21CUSTOM_DATA_22CUSTOM_DATA_23CUSTOM_DATA_24CUSTOM_DATA_25CUSTOM_DATA_26CUSTOM_DATA_27CUSTOM_DATA_28CUSTOM_DATA_29CUSTOM_DATA_3CUSTOM_DATA_30CUSTOM_DATA_4CUSTOM_DATA_5CUSTOM_DATA_6CUSTOM_DATA_7CUSTOM_DATA_8CUSTOM_DATA_9CUSTOM_USER_IDDAYDEAL_IDDEVICE_CLASSDEVICE_TYPEDOMAINERROR_CODEERROR_PERCENTAGEERROR_POSITIONEXIT_POSITIONEXPERIMENT_NAMEHOURIP_ADDRESSISPIS_LINEARLANGUAGELICENSE_KEYMANIFEST_DOWNLOAD_TIMEMEDIA_PATHMEDIA_SERVERMEDIA_URLMIDPOINTMINUTEMIN_SUGGESTED_DURATIONMONTHOPERATINGSYSTEMOPERATINGSYSTEM_VERSION_MAJORPAGE_LOAD_TIMEPAGE_LOAD_TYPEPATHPERCENTAGE_IN_VIEWPORTPLATFORMPLAYERPLAYER_KEYPLAYER_STARTUPTIMEPLAYER_TECHPLAYER_VERSIONPLAY_PERCENTAGEQUARTILE_1QUARTILE_3REGIONSCALE_FACTORSCREEN_HEIGHTSCREEN_ORIENTATIONSCREEN_WIDTHSIZESKIPPEDSKIP_PERCENTAGESKIP_POSITIONSTARTEDSTREAM_FORMATSURVEY_URLTIMETIME_IN_VIEWPORTTIME_PLAYEDUNIVERSAL_AD_ID_REGISTRYUNIVERSAL_AD_ID_VALUEUSER_IDVIDEO_BITRATEVIDEO_CODECVIDEO_IDVIDEO_IMPRESSION_IDVIDEO_TITLEVIDEO_WINDOW_HEIGHTVIDEO_WINDOW_WIDTH
\ No newline at end of file diff --git a/docs/enums/AdaptationSetRole.html b/docs/enums/AdaptationSetRole.html index b92596213..bb40bf161 100644 --- a/docs/enums/AdaptationSetRole.html +++ b/docs/enums/AdaptationSetRole.html @@ -1,8 +1,8 @@ -AdaptationSetRole | @bitmovin/api-sdk

Enumeration AdaptationSetRole

Export

Enumeration Members

ALTERNATE +AdaptationSetRole | @bitmovin/api-sdk

Enumeration AdaptationSetRole

Export

Enumeration Members

ALTERNATE CAPTION COMMENTARY DUB MAIN SUBTITLE SUPPLEMENTARY -

Enumeration Members

ALTERNATE

ALTERNATE: "ALTERNATE"

CAPTION

CAPTION: "CAPTION"

COMMENTARY

COMMENTARY: "COMMENTARY"

DUB

DUB: "DUB"

MAIN

MAIN: "MAIN"

SUBTITLE

SUBTITLE: "SUBTITLE"

SUPPLEMENTARY

SUPPLEMENTARY: "SUPPLEMENTARY"

Settings

Member Visibility

Theme

On This Page

ALTERNATECAPTIONCOMMENTARYDUBMAINSUBTITLESUPPLEMENTARY
\ No newline at end of file +

Enumeration Members

ALTERNATE

ALTERNATE: "ALTERNATE"

CAPTION

CAPTION: "CAPTION"

COMMENTARY

COMMENTARY: "COMMENTARY"

DUB

DUB: "DUB"

MAIN

MAIN: "MAIN"

SUBTITLE

SUBTITLE: "SUBTITLE"

SUPPLEMENTARY

SUPPLEMENTARY: "SUPPLEMENTARY"

Settings

Member Visibility

Theme

On This Page

ALTERNATECAPTIONCOMMENTARYDUBMAINSUBTITLESUPPLEMENTARY
\ No newline at end of file diff --git a/docs/enums/AdaptationSetType.html b/docs/enums/AdaptationSetType.html index 042d66210..f1f3204be 100644 --- a/docs/enums/AdaptationSetType.html +++ b/docs/enums/AdaptationSetType.html @@ -1,5 +1,5 @@ -AdaptationSetType | @bitmovin/api-sdk

Enumeration AdaptationSetType

Export

Enumeration Members

AUDIO +AdaptationSetType | @bitmovin/api-sdk

Enumeration AdaptationSetType

Export

Enumeration Members

AUDIO IMAGE SUBTITLE VIDEO -

Enumeration Members

AUDIO

AUDIO: "AUDIO"

IMAGE

IMAGE: "IMAGE"

SUBTITLE

SUBTITLE: "SUBTITLE"

VIDEO

VIDEO: "VIDEO"

Settings

Member Visibility

Theme

On This Page

AUDIOIMAGESUBTITLEVIDEO
\ No newline at end of file +

Enumeration Members

AUDIO

AUDIO: "AUDIO"

IMAGE

IMAGE: "IMAGE"

SUBTITLE

SUBTITLE: "SUBTITLE"

VIDEO

VIDEO: "VIDEO"

Settings

Member Visibility

Theme

On This Page

AUDIOIMAGESUBTITLEVIDEO
\ No newline at end of file diff --git a/docs/enums/AdaptiveQuantMode.html b/docs/enums/AdaptiveQuantMode.html index 5ec8ea023..cee4e2358 100644 --- a/docs/enums/AdaptiveQuantMode.html +++ b/docs/enums/AdaptiveQuantMode.html @@ -1,5 +1,5 @@ -AdaptiveQuantMode | @bitmovin/api-sdk

Enumeration AdaptiveQuantMode

Export

Enumeration Members

AUTO_VARIANCE +AdaptiveQuantMode | @bitmovin/api-sdk

Enumeration AdaptiveQuantMode

Export

Enumeration Members

AUTO_VARIANCE AUTO_VARIANCE_DARK_SCENES DISABLED VARIANCE -

Enumeration Members

AUTO_VARIANCE

AUTO_VARIANCE: "AUTO_VARIANCE"

AUTO_VARIANCE_DARK_SCENES

AUTO_VARIANCE_DARK_SCENES: "AUTO_VARIANCE_DARK_SCENES"

DISABLED

DISABLED: "DISABLED"

VARIANCE

VARIANCE: "VARIANCE"

Settings

Member Visibility

Theme

On This Page

AUTO_VARIANCEAUTO_VARIANCE_DARK_SCENESDISABLEDVARIANCE
\ No newline at end of file +

Enumeration Members

AUTO_VARIANCE

AUTO_VARIANCE: "AUTO_VARIANCE"

AUTO_VARIANCE_DARK_SCENES

AUTO_VARIANCE_DARK_SCENES: "AUTO_VARIANCE_DARK_SCENES"

DISABLED

DISABLED: "DISABLED"

VARIANCE

VARIANCE: "VARIANCE"

Settings

Member Visibility

Theme

On This Page

AUTO_VARIANCEAUTO_VARIANCE_DARK_SCENESDISABLEDVARIANCE
\ No newline at end of file diff --git a/docs/enums/AesEncryptionMethod.html b/docs/enums/AesEncryptionMethod.html index 6d7c06fc8..c3b7fcd59 100644 --- a/docs/enums/AesEncryptionMethod.html +++ b/docs/enums/AesEncryptionMethod.html @@ -1,4 +1,4 @@ AesEncryptionMethod | @bitmovin/api-sdk

Enumeration AesEncryptionMethod

Detailed encryption method

-

Export

Enumeration Members

AES_128 +

Export

Enumeration Members

AES_128 SAMPLE_AES -

Enumeration Members

AES_128

AES_128: "AES_128"

SAMPLE_AES

SAMPLE_AES: "SAMPLE_AES"

Settings

Member Visibility

Theme

On This Page

AES_128SAMPLE_AES
\ No newline at end of file +

Enumeration Members

AES_128

AES_128: "AES_128"

SAMPLE_AES

SAMPLE_AES: "SAMPLE_AES"

Settings

Member Visibility

Theme

On This Page

AES_128SAMPLE_AES
\ No newline at end of file diff --git a/docs/enums/AkamaiMslStreamFormat.html b/docs/enums/AkamaiMslStreamFormat.html index c57936fa2..09b61c0fc 100644 --- a/docs/enums/AkamaiMslStreamFormat.html +++ b/docs/enums/AkamaiMslStreamFormat.html @@ -1,4 +1,4 @@ -AkamaiMslStreamFormat | @bitmovin/api-sdk

Enumeration AkamaiMslStreamFormat

Export

Enumeration Members

CMAF +AkamaiMslStreamFormat | @bitmovin/api-sdk

Enumeration AkamaiMslStreamFormat

Export

Enumeration Members

CMAF DASH HLS -

Enumeration Members

CMAF

CMAF: "CMAF"

DASH

DASH: "DASH"

HLS

HLS: "HLS"

Settings

Member Visibility

Theme

On This Page

CMAFDASHHLS
\ No newline at end of file +

Enumeration Members

CMAF

CMAF: "CMAF"

DASH

DASH: "DASH"

HLS

HLS: "HLS"

Settings

Member Visibility

Theme

On This Page

CMAFDASHHLS
\ No newline at end of file diff --git a/docs/enums/AkamaiMslVersion.html b/docs/enums/AkamaiMslVersion.html index f4ce08e5f..19e927cd3 100644 --- a/docs/enums/AkamaiMslVersion.html +++ b/docs/enums/AkamaiMslVersion.html @@ -1,2 +1,2 @@ -AkamaiMslVersion | @bitmovin/api-sdk

Enumeration AkamaiMslVersion

Export

Enumeration Members

MSL4 -

Enumeration Members

MSL4

MSL4: "MSL4"

Settings

Member Visibility

Theme

On This Page

MSL4
\ No newline at end of file +AkamaiMslVersion | @bitmovin/api-sdk

Enumeration AkamaiMslVersion

Export

Enumeration Members

MSL4 +

Enumeration Members

MSL4

MSL4: "MSL4"

Settings

Member Visibility

Theme

On This Page

MSL4
\ No newline at end of file diff --git a/docs/enums/AnalyticsAttribute.html b/docs/enums/AnalyticsAttribute.html index 0c719f3c7..f1e12f20b 100644 --- a/docs/enums/AnalyticsAttribute.html +++ b/docs/enums/AnalyticsAttribute.html @@ -1,4 +1,4 @@ -AnalyticsAttribute | @bitmovin/api-sdk

Enumeration AnalyticsAttribute

Export

Enumeration Members

ACTIVE_PLAYER_STARTUPTIME +AnalyticsAttribute | @bitmovin/api-sdk

Enumeration AnalyticsAttribute

Export

Enumeration Members

ACTIVE_PLAYER_STARTUPTIME AD ANALYTICS_VERSION AUDIO_BITRATE @@ -120,4 +120,4 @@ VIDEO_WINDOW_HEIGHT VIDEO_WINDOW_WIDTH VIEWTIME -

Enumeration Members

ACTIVE_PLAYER_STARTUPTIME

ACTIVE_PLAYER_STARTUPTIME: "ACTIVE_PLAYER_STARTUPTIME"

AD

AD: "AD"

ANALYTICS_VERSION

ANALYTICS_VERSION: "ANALYTICS_VERSION"

AUDIO_BITRATE

AUDIO_BITRATE: "AUDIO_BITRATE"

AUDIO_CODEC

AUDIO_CODEC: "AUDIO_CODEC"

AUTOPLAY

AUTOPLAY: "AUTOPLAY"

BROWSER

BROWSER: "BROWSER"

BROWSER_IS_BOT

BROWSER_IS_BOT: "BROWSER_IS_BOT"

BROWSER_VERSION_MAJOR

BROWSER_VERSION_MAJOR: "BROWSER_VERSION_MAJOR"

BUFFERED

BUFFERED: "BUFFERED"

CAST_TECH

CAST_TECH: "CAST_TECH"

CDN_PROVIDER

CDN_PROVIDER: "CDN_PROVIDER"

CITY

CITY: "CITY"

CLIENT_TIME

CLIENT_TIME: "CLIENT_TIME"

COUNTRY

COUNTRY: "COUNTRY"

CUSTOM_DATA_1

CUSTOM_DATA_1: "CUSTOM_DATA_1"

CUSTOM_DATA_10

CUSTOM_DATA_10: "CUSTOM_DATA_10"

CUSTOM_DATA_11

CUSTOM_DATA_11: "CUSTOM_DATA_11"

CUSTOM_DATA_12

CUSTOM_DATA_12: "CUSTOM_DATA_12"

CUSTOM_DATA_13

CUSTOM_DATA_13: "CUSTOM_DATA_13"

CUSTOM_DATA_14

CUSTOM_DATA_14: "CUSTOM_DATA_14"

CUSTOM_DATA_15

CUSTOM_DATA_15: "CUSTOM_DATA_15"

CUSTOM_DATA_16

CUSTOM_DATA_16: "CUSTOM_DATA_16"

CUSTOM_DATA_17

CUSTOM_DATA_17: "CUSTOM_DATA_17"

CUSTOM_DATA_18

CUSTOM_DATA_18: "CUSTOM_DATA_18"

CUSTOM_DATA_19

CUSTOM_DATA_19: "CUSTOM_DATA_19"

CUSTOM_DATA_2

CUSTOM_DATA_2: "CUSTOM_DATA_2"

CUSTOM_DATA_20

CUSTOM_DATA_20: "CUSTOM_DATA_20"

CUSTOM_DATA_21

CUSTOM_DATA_21: "CUSTOM_DATA_21"

CUSTOM_DATA_22

CUSTOM_DATA_22: "CUSTOM_DATA_22"

CUSTOM_DATA_23

CUSTOM_DATA_23: "CUSTOM_DATA_23"

CUSTOM_DATA_24

CUSTOM_DATA_24: "CUSTOM_DATA_24"

CUSTOM_DATA_25

CUSTOM_DATA_25: "CUSTOM_DATA_25"

CUSTOM_DATA_26

CUSTOM_DATA_26: "CUSTOM_DATA_26"

CUSTOM_DATA_27

CUSTOM_DATA_27: "CUSTOM_DATA_27"

CUSTOM_DATA_28

CUSTOM_DATA_28: "CUSTOM_DATA_28"

CUSTOM_DATA_29

CUSTOM_DATA_29: "CUSTOM_DATA_29"

CUSTOM_DATA_3

CUSTOM_DATA_3: "CUSTOM_DATA_3"

CUSTOM_DATA_30

CUSTOM_DATA_30: "CUSTOM_DATA_30"

CUSTOM_DATA_4

CUSTOM_DATA_4: "CUSTOM_DATA_4"

CUSTOM_DATA_5

CUSTOM_DATA_5: "CUSTOM_DATA_5"

CUSTOM_DATA_6

CUSTOM_DATA_6: "CUSTOM_DATA_6"

CUSTOM_DATA_7

CUSTOM_DATA_7: "CUSTOM_DATA_7"

CUSTOM_DATA_8

CUSTOM_DATA_8: "CUSTOM_DATA_8"

CUSTOM_DATA_9

CUSTOM_DATA_9: "CUSTOM_DATA_9"

CUSTOM_USER_ID

CUSTOM_USER_ID: "CUSTOM_USER_ID"

DAY

DAY: "DAY"

DEVICE_CLASS

DEVICE_CLASS: "DEVICE_CLASS"

DEVICE_TYPE

DEVICE_TYPE: "DEVICE_TYPE"

DOMAIN

DOMAIN: "DOMAIN"

DRM_LOAD_TIME

DRM_LOAD_TIME: "DRM_LOAD_TIME"

DRM_TYPE

DRM_TYPE: "DRM_TYPE"

DROPPED_FRAMES

DROPPED_FRAMES: "DROPPED_FRAMES"

DURATION

DURATION: "DURATION"

ERROR_CODE

ERROR_CODE: "ERROR_CODE"

ERROR_MESSAGE

ERROR_MESSAGE: "ERROR_MESSAGE"

ERROR_PERCENTAGE

ERROR_PERCENTAGE: "ERROR_PERCENTAGE"

ERROR_RATE

ERROR_RATE: "ERROR_RATE"

EXPERIMENT_NAME

EXPERIMENT_NAME: "EXPERIMENT_NAME"

FUNCTION

FUNCTION: "FUNCTION"

HOUR

HOUR: "HOUR"

IMPRESSION_ID

IMPRESSION_ID: "IMPRESSION_ID"

INITIAL_TIME_TO_TARGET_LATENCY

INITIAL_TIME_TO_TARGET_LATENCY: "INITIAL_TIME_TO_TARGET_LATENCY"

IP_ADDRESS

IP_ADDRESS: "IP_ADDRESS"

ISP

ISP: "ISP"

IS_CASTING

IS_CASTING: "IS_CASTING"

IS_LIVE

IS_LIVE: "IS_LIVE"

IS_LOW_LATENCY

IS_LOW_LATENCY: "IS_LOW_LATENCY"

IS_MUTED

IS_MUTED: "IS_MUTED"

LANGUAGE

LANGUAGE: "LANGUAGE"

LATENCY

LATENCY: "LATENCY"

LICENSE_KEY

LICENSE_KEY: "LICENSE_KEY"

M3U8_URL

M3U8_URL: "M3U8_URL"

MINUTE

MINUTE: "MINUTE"

MONTH

MONTH: "MONTH"

MPD_URL

MPD_URL: "MPD_URL"

OPERATINGSYSTEM

OPERATINGSYSTEM: "OPERATINGSYSTEM"

OPERATINGSYSTEM_VERSION_MAJOR

OPERATINGSYSTEM_VERSION_MAJOR: "OPERATINGSYSTEM_VERSION_MAJOR"

PAGE_LOAD_TIME

PAGE_LOAD_TIME: "PAGE_LOAD_TIME"

PAGE_LOAD_TYPE

PAGE_LOAD_TYPE: "PAGE_LOAD_TYPE"

PATH

PATH: "PATH"

PAUSED

PAUSED: "PAUSED"

PLATFORM

PLATFORM: "PLATFORM"

PLAYED

PLAYED: "PLAYED"

PLAYER

PLAYER: "PLAYER"

PLAYER_KEY

PLAYER_KEY: "PLAYER_KEY"

PLAYER_STARTUPTIME

PLAYER_STARTUPTIME: "PLAYER_STARTUPTIME"

PLAYER_TECH

PLAYER_TECH: "PLAYER_TECH"

PLAYER_VERSION

PLAYER_VERSION: "PLAYER_VERSION"

PROG_URL

PROG_URL: "PROG_URL"

REBUFFER_PERCENTAGE

REBUFFER_PERCENTAGE: "REBUFFER_PERCENTAGE"

REGION

REGION: "REGION"

SCALE_FACTOR

SCALE_FACTOR: "SCALE_FACTOR"

SCREEN_HEIGHT

SCREEN_HEIGHT: "SCREEN_HEIGHT"

SCREEN_ORIENTATION

SCREEN_ORIENTATION: "SCREEN_ORIENTATION"

SCREEN_WIDTH

SCREEN_WIDTH: "SCREEN_WIDTH"

SEEKED

SEEKED: "SEEKED"

SEQUENCE_NUMBER

SEQUENCE_NUMBER: "SEQUENCE_NUMBER"

SIZE

SIZE: "SIZE"

STARTUPTIME

STARTUPTIME: "STARTUPTIME"

STREAM_FORMAT

STREAM_FORMAT: "STREAM_FORMAT"

SUPPORTED_VIDEO_CODECS

SUPPORTED_VIDEO_CODECS: "SUPPORTED_VIDEO_CODECS"

TARGET_LATENCY

TARGET_LATENCY: "TARGET_LATENCY"

TARGET_LATENCY_DELTA

TARGET_LATENCY_DELTA: "TARGET_LATENCY_DELTA"

TIME

TIME: "TIME"

TIME_TO_TARGET_LATENCY

TIME_TO_TARGET_LATENCY: "TIME_TO_TARGET_LATENCY"

USER_ID

USER_ID: "USER_ID"

VIDEOSTART_FAILED

VIDEOSTART_FAILED: "VIDEOSTART_FAILED"

VIDEOSTART_FAILED_REASON

VIDEOSTART_FAILED_REASON: "VIDEOSTART_FAILED_REASON"

VIDEOTIME_END

VIDEOTIME_END: "VIDEOTIME_END"

VIDEOTIME_START

VIDEOTIME_START: "VIDEOTIME_START"

VIDEO_BITRATE

VIDEO_BITRATE: "VIDEO_BITRATE"

VIDEO_CODEC

VIDEO_CODEC: "VIDEO_CODEC"

VIDEO_DURATION

VIDEO_DURATION: "VIDEO_DURATION"

VIDEO_ID

VIDEO_ID: "VIDEO_ID"

VIDEO_PLAYBACK_HEIGHT

VIDEO_PLAYBACK_HEIGHT: "VIDEO_PLAYBACK_HEIGHT"

VIDEO_PLAYBACK_WIDTH

VIDEO_PLAYBACK_WIDTH: "VIDEO_PLAYBACK_WIDTH"

VIDEO_STARTUPTIME

VIDEO_STARTUPTIME: "VIDEO_STARTUPTIME"

VIDEO_TITLE

VIDEO_TITLE: "VIDEO_TITLE"

VIDEO_WINDOW_HEIGHT

VIDEO_WINDOW_HEIGHT: "VIDEO_WINDOW_HEIGHT"

VIDEO_WINDOW_WIDTH

VIDEO_WINDOW_WIDTH: "VIDEO_WINDOW_WIDTH"

VIEWTIME

VIEWTIME: "VIEWTIME"

Settings

Member Visibility

Theme

On This Page

ACTIVE_PLAYER_STARTUPTIMEADANALYTICS_VERSIONAUDIO_BITRATEAUDIO_CODECAUTOPLAYBROWSERBROWSER_IS_BOTBROWSER_VERSION_MAJORBUFFEREDCAST_TECHCDN_PROVIDERCITYCLIENT_TIMECOUNTRYCUSTOM_DATA_1CUSTOM_DATA_10CUSTOM_DATA_11CUSTOM_DATA_12CUSTOM_DATA_13CUSTOM_DATA_14CUSTOM_DATA_15CUSTOM_DATA_16CUSTOM_DATA_17CUSTOM_DATA_18CUSTOM_DATA_19CUSTOM_DATA_2CUSTOM_DATA_20CUSTOM_DATA_21CUSTOM_DATA_22CUSTOM_DATA_23CUSTOM_DATA_24CUSTOM_DATA_25CUSTOM_DATA_26CUSTOM_DATA_27CUSTOM_DATA_28CUSTOM_DATA_29CUSTOM_DATA_3CUSTOM_DATA_30CUSTOM_DATA_4CUSTOM_DATA_5CUSTOM_DATA_6CUSTOM_DATA_7CUSTOM_DATA_8CUSTOM_DATA_9CUSTOM_USER_IDDAYDEVICE_CLASSDEVICE_TYPEDOMAINDRM_LOAD_TIMEDRM_TYPEDROPPED_FRAMESDURATIONERROR_CODEERROR_MESSAGEERROR_PERCENTAGEERROR_RATEEXPERIMENT_NAMEFUNCTIONHOURIMPRESSION_IDINITIAL_TIME_TO_TARGET_LATENCYIP_ADDRESSISPIS_CASTINGIS_LIVEIS_LOW_LATENCYIS_MUTEDLANGUAGELATENCYLICENSE_KEYM3U8_URLMINUTEMONTHMPD_URLOPERATINGSYSTEMOPERATINGSYSTEM_VERSION_MAJORPAGE_LOAD_TIMEPAGE_LOAD_TYPEPATHPAUSEDPLATFORMPLAYEDPLAYERPLAYER_KEYPLAYER_STARTUPTIMEPLAYER_TECHPLAYER_VERSIONPROG_URLREBUFFER_PERCENTAGEREGIONSCALE_FACTORSCREEN_HEIGHTSCREEN_ORIENTATIONSCREEN_WIDTHSEEKEDSEQUENCE_NUMBERSIZESTARTUPTIMESTREAM_FORMATSUPPORTED_VIDEO_CODECSTARGET_LATENCYTARGET_LATENCY_DELTATIMETIME_TO_TARGET_LATENCYUSER_IDVIDEOSTART_FAILEDVIDEOSTART_FAILED_REASONVIDEOTIME_ENDVIDEOTIME_STARTVIDEO_BITRATEVIDEO_CODECVIDEO_DURATIONVIDEO_IDVIDEO_PLAYBACK_HEIGHTVIDEO_PLAYBACK_WIDTHVIDEO_STARTUPTIMEVIDEO_TITLEVIDEO_WINDOW_HEIGHTVIDEO_WINDOW_WIDTHVIEWTIME
\ No newline at end of file +

Enumeration Members

ACTIVE_PLAYER_STARTUPTIME

ACTIVE_PLAYER_STARTUPTIME: "ACTIVE_PLAYER_STARTUPTIME"

AD

AD: "AD"

ANALYTICS_VERSION

ANALYTICS_VERSION: "ANALYTICS_VERSION"

AUDIO_BITRATE

AUDIO_BITRATE: "AUDIO_BITRATE"

AUDIO_CODEC

AUDIO_CODEC: "AUDIO_CODEC"

AUTOPLAY

AUTOPLAY: "AUTOPLAY"

BROWSER

BROWSER: "BROWSER"

BROWSER_IS_BOT

BROWSER_IS_BOT: "BROWSER_IS_BOT"

BROWSER_VERSION_MAJOR

BROWSER_VERSION_MAJOR: "BROWSER_VERSION_MAJOR"

BUFFERED

BUFFERED: "BUFFERED"

CAST_TECH

CAST_TECH: "CAST_TECH"

CDN_PROVIDER

CDN_PROVIDER: "CDN_PROVIDER"

CITY

CITY: "CITY"

CLIENT_TIME

CLIENT_TIME: "CLIENT_TIME"

COUNTRY

COUNTRY: "COUNTRY"

CUSTOM_DATA_1

CUSTOM_DATA_1: "CUSTOM_DATA_1"

CUSTOM_DATA_10

CUSTOM_DATA_10: "CUSTOM_DATA_10"

CUSTOM_DATA_11

CUSTOM_DATA_11: "CUSTOM_DATA_11"

CUSTOM_DATA_12

CUSTOM_DATA_12: "CUSTOM_DATA_12"

CUSTOM_DATA_13

CUSTOM_DATA_13: "CUSTOM_DATA_13"

CUSTOM_DATA_14

CUSTOM_DATA_14: "CUSTOM_DATA_14"

CUSTOM_DATA_15

CUSTOM_DATA_15: "CUSTOM_DATA_15"

CUSTOM_DATA_16

CUSTOM_DATA_16: "CUSTOM_DATA_16"

CUSTOM_DATA_17

CUSTOM_DATA_17: "CUSTOM_DATA_17"

CUSTOM_DATA_18

CUSTOM_DATA_18: "CUSTOM_DATA_18"

CUSTOM_DATA_19

CUSTOM_DATA_19: "CUSTOM_DATA_19"

CUSTOM_DATA_2

CUSTOM_DATA_2: "CUSTOM_DATA_2"

CUSTOM_DATA_20

CUSTOM_DATA_20: "CUSTOM_DATA_20"

CUSTOM_DATA_21

CUSTOM_DATA_21: "CUSTOM_DATA_21"

CUSTOM_DATA_22

CUSTOM_DATA_22: "CUSTOM_DATA_22"

CUSTOM_DATA_23

CUSTOM_DATA_23: "CUSTOM_DATA_23"

CUSTOM_DATA_24

CUSTOM_DATA_24: "CUSTOM_DATA_24"

CUSTOM_DATA_25

CUSTOM_DATA_25: "CUSTOM_DATA_25"

CUSTOM_DATA_26

CUSTOM_DATA_26: "CUSTOM_DATA_26"

CUSTOM_DATA_27

CUSTOM_DATA_27: "CUSTOM_DATA_27"

CUSTOM_DATA_28

CUSTOM_DATA_28: "CUSTOM_DATA_28"

CUSTOM_DATA_29

CUSTOM_DATA_29: "CUSTOM_DATA_29"

CUSTOM_DATA_3

CUSTOM_DATA_3: "CUSTOM_DATA_3"

CUSTOM_DATA_30

CUSTOM_DATA_30: "CUSTOM_DATA_30"

CUSTOM_DATA_4

CUSTOM_DATA_4: "CUSTOM_DATA_4"

CUSTOM_DATA_5

CUSTOM_DATA_5: "CUSTOM_DATA_5"

CUSTOM_DATA_6

CUSTOM_DATA_6: "CUSTOM_DATA_6"

CUSTOM_DATA_7

CUSTOM_DATA_7: "CUSTOM_DATA_7"

CUSTOM_DATA_8

CUSTOM_DATA_8: "CUSTOM_DATA_8"

CUSTOM_DATA_9

CUSTOM_DATA_9: "CUSTOM_DATA_9"

CUSTOM_USER_ID

CUSTOM_USER_ID: "CUSTOM_USER_ID"

DAY

DAY: "DAY"

DEVICE_CLASS

DEVICE_CLASS: "DEVICE_CLASS"

DEVICE_TYPE

DEVICE_TYPE: "DEVICE_TYPE"

DOMAIN

DOMAIN: "DOMAIN"

DRM_LOAD_TIME

DRM_LOAD_TIME: "DRM_LOAD_TIME"

DRM_TYPE

DRM_TYPE: "DRM_TYPE"

DROPPED_FRAMES

DROPPED_FRAMES: "DROPPED_FRAMES"

DURATION

DURATION: "DURATION"

ERROR_CODE

ERROR_CODE: "ERROR_CODE"

ERROR_MESSAGE

ERROR_MESSAGE: "ERROR_MESSAGE"

ERROR_PERCENTAGE

ERROR_PERCENTAGE: "ERROR_PERCENTAGE"

ERROR_RATE

ERROR_RATE: "ERROR_RATE"

EXPERIMENT_NAME

EXPERIMENT_NAME: "EXPERIMENT_NAME"

FUNCTION

FUNCTION: "FUNCTION"

HOUR

HOUR: "HOUR"

IMPRESSION_ID

IMPRESSION_ID: "IMPRESSION_ID"

INITIAL_TIME_TO_TARGET_LATENCY

INITIAL_TIME_TO_TARGET_LATENCY: "INITIAL_TIME_TO_TARGET_LATENCY"

IP_ADDRESS

IP_ADDRESS: "IP_ADDRESS"

ISP

ISP: "ISP"

IS_CASTING

IS_CASTING: "IS_CASTING"

IS_LIVE

IS_LIVE: "IS_LIVE"

IS_LOW_LATENCY

IS_LOW_LATENCY: "IS_LOW_LATENCY"

IS_MUTED

IS_MUTED: "IS_MUTED"

LANGUAGE

LANGUAGE: "LANGUAGE"

LATENCY

LATENCY: "LATENCY"

LICENSE_KEY

LICENSE_KEY: "LICENSE_KEY"

M3U8_URL

M3U8_URL: "M3U8_URL"

MINUTE

MINUTE: "MINUTE"

MONTH

MONTH: "MONTH"

MPD_URL

MPD_URL: "MPD_URL"

OPERATINGSYSTEM

OPERATINGSYSTEM: "OPERATINGSYSTEM"

OPERATINGSYSTEM_VERSION_MAJOR

OPERATINGSYSTEM_VERSION_MAJOR: "OPERATINGSYSTEM_VERSION_MAJOR"

PAGE_LOAD_TIME

PAGE_LOAD_TIME: "PAGE_LOAD_TIME"

PAGE_LOAD_TYPE

PAGE_LOAD_TYPE: "PAGE_LOAD_TYPE"

PATH

PATH: "PATH"

PAUSED

PAUSED: "PAUSED"

PLATFORM

PLATFORM: "PLATFORM"

PLAYED

PLAYED: "PLAYED"

PLAYER

PLAYER: "PLAYER"

PLAYER_KEY

PLAYER_KEY: "PLAYER_KEY"

PLAYER_STARTUPTIME

PLAYER_STARTUPTIME: "PLAYER_STARTUPTIME"

PLAYER_TECH

PLAYER_TECH: "PLAYER_TECH"

PLAYER_VERSION

PLAYER_VERSION: "PLAYER_VERSION"

PROG_URL

PROG_URL: "PROG_URL"

REBUFFER_PERCENTAGE

REBUFFER_PERCENTAGE: "REBUFFER_PERCENTAGE"

REGION

REGION: "REGION"

SCALE_FACTOR

SCALE_FACTOR: "SCALE_FACTOR"

SCREEN_HEIGHT

SCREEN_HEIGHT: "SCREEN_HEIGHT"

SCREEN_ORIENTATION

SCREEN_ORIENTATION: "SCREEN_ORIENTATION"

SCREEN_WIDTH

SCREEN_WIDTH: "SCREEN_WIDTH"

SEEKED

SEEKED: "SEEKED"

SEQUENCE_NUMBER

SEQUENCE_NUMBER: "SEQUENCE_NUMBER"

SIZE

SIZE: "SIZE"

STARTUPTIME

STARTUPTIME: "STARTUPTIME"

STREAM_FORMAT

STREAM_FORMAT: "STREAM_FORMAT"

SUPPORTED_VIDEO_CODECS

SUPPORTED_VIDEO_CODECS: "SUPPORTED_VIDEO_CODECS"

TARGET_LATENCY

TARGET_LATENCY: "TARGET_LATENCY"

TARGET_LATENCY_DELTA

TARGET_LATENCY_DELTA: "TARGET_LATENCY_DELTA"

TIME

TIME: "TIME"

TIME_TO_TARGET_LATENCY

TIME_TO_TARGET_LATENCY: "TIME_TO_TARGET_LATENCY"

USER_ID

USER_ID: "USER_ID"

VIDEOSTART_FAILED

VIDEOSTART_FAILED: "VIDEOSTART_FAILED"

VIDEOSTART_FAILED_REASON

VIDEOSTART_FAILED_REASON: "VIDEOSTART_FAILED_REASON"

VIDEOTIME_END

VIDEOTIME_END: "VIDEOTIME_END"

VIDEOTIME_START

VIDEOTIME_START: "VIDEOTIME_START"

VIDEO_BITRATE

VIDEO_BITRATE: "VIDEO_BITRATE"

VIDEO_CODEC

VIDEO_CODEC: "VIDEO_CODEC"

VIDEO_DURATION

VIDEO_DURATION: "VIDEO_DURATION"

VIDEO_ID

VIDEO_ID: "VIDEO_ID"

VIDEO_PLAYBACK_HEIGHT

VIDEO_PLAYBACK_HEIGHT: "VIDEO_PLAYBACK_HEIGHT"

VIDEO_PLAYBACK_WIDTH

VIDEO_PLAYBACK_WIDTH: "VIDEO_PLAYBACK_WIDTH"

VIDEO_STARTUPTIME

VIDEO_STARTUPTIME: "VIDEO_STARTUPTIME"

VIDEO_TITLE

VIDEO_TITLE: "VIDEO_TITLE"

VIDEO_WINDOW_HEIGHT

VIDEO_WINDOW_HEIGHT: "VIDEO_WINDOW_HEIGHT"

VIDEO_WINDOW_WIDTH

VIDEO_WINDOW_WIDTH: "VIDEO_WINDOW_WIDTH"

VIEWTIME

VIEWTIME: "VIEWTIME"

Settings

Member Visibility

Theme

On This Page

ACTIVE_PLAYER_STARTUPTIMEADANALYTICS_VERSIONAUDIO_BITRATEAUDIO_CODECAUTOPLAYBROWSERBROWSER_IS_BOTBROWSER_VERSION_MAJORBUFFEREDCAST_TECHCDN_PROVIDERCITYCLIENT_TIMECOUNTRYCUSTOM_DATA_1CUSTOM_DATA_10CUSTOM_DATA_11CUSTOM_DATA_12CUSTOM_DATA_13CUSTOM_DATA_14CUSTOM_DATA_15CUSTOM_DATA_16CUSTOM_DATA_17CUSTOM_DATA_18CUSTOM_DATA_19CUSTOM_DATA_2CUSTOM_DATA_20CUSTOM_DATA_21CUSTOM_DATA_22CUSTOM_DATA_23CUSTOM_DATA_24CUSTOM_DATA_25CUSTOM_DATA_26CUSTOM_DATA_27CUSTOM_DATA_28CUSTOM_DATA_29CUSTOM_DATA_3CUSTOM_DATA_30CUSTOM_DATA_4CUSTOM_DATA_5CUSTOM_DATA_6CUSTOM_DATA_7CUSTOM_DATA_8CUSTOM_DATA_9CUSTOM_USER_IDDAYDEVICE_CLASSDEVICE_TYPEDOMAINDRM_LOAD_TIMEDRM_TYPEDROPPED_FRAMESDURATIONERROR_CODEERROR_MESSAGEERROR_PERCENTAGEERROR_RATEEXPERIMENT_NAMEFUNCTIONHOURIMPRESSION_IDINITIAL_TIME_TO_TARGET_LATENCYIP_ADDRESSISPIS_CASTINGIS_LIVEIS_LOW_LATENCYIS_MUTEDLANGUAGELATENCYLICENSE_KEYM3U8_URLMINUTEMONTHMPD_URLOPERATINGSYSTEMOPERATINGSYSTEM_VERSION_MAJORPAGE_LOAD_TIMEPAGE_LOAD_TYPEPATHPAUSEDPLATFORMPLAYEDPLAYERPLAYER_KEYPLAYER_STARTUPTIMEPLAYER_TECHPLAYER_VERSIONPROG_URLREBUFFER_PERCENTAGEREGIONSCALE_FACTORSCREEN_HEIGHTSCREEN_ORIENTATIONSCREEN_WIDTHSEEKEDSEQUENCE_NUMBERSIZESTARTUPTIMESTREAM_FORMATSUPPORTED_VIDEO_CODECSTARGET_LATENCYTARGET_LATENCY_DELTATIMETIME_TO_TARGET_LATENCYUSER_IDVIDEOSTART_FAILEDVIDEOSTART_FAILED_REASONVIDEOTIME_ENDVIDEOTIME_STARTVIDEO_BITRATEVIDEO_CODECVIDEO_DURATIONVIDEO_IDVIDEO_PLAYBACK_HEIGHTVIDEO_PLAYBACK_WIDTHVIDEO_STARTUPTIMEVIDEO_TITLEVIDEO_WINDOW_HEIGHTVIDEO_WINDOW_WIDTHVIEWTIME
\ No newline at end of file diff --git a/docs/enums/AnalyticsExportFileFormat.html b/docs/enums/AnalyticsExportFileFormat.html index e911eb8c7..7c96c7527 100644 --- a/docs/enums/AnalyticsExportFileFormat.html +++ b/docs/enums/AnalyticsExportFileFormat.html @@ -1,4 +1,4 @@ AnalyticsExportFileFormat | @bitmovin/api-sdk

Enumeration AnalyticsExportFileFormat

Analytics Export File Format

-

Export

Enumeration Members

CSV +

Export

Enumeration Members

CSV PARQUET -

Enumeration Members

CSV

CSV: "CSV"

PARQUET

PARQUET: "PARQUET"

Settings

Member Visibility

Theme

On This Page

CSVPARQUET
\ No newline at end of file +

Enumeration Members

CSV

CSV: "CSV"

PARQUET

PARQUET: "PARQUET"

Settings

Member Visibility

Theme

On This Page

CSVPARQUET
\ No newline at end of file diff --git a/docs/enums/AnalyticsExportStatus.html b/docs/enums/AnalyticsExportStatus.html index 5a8d8ab98..0a022056e 100644 --- a/docs/enums/AnalyticsExportStatus.html +++ b/docs/enums/AnalyticsExportStatus.html @@ -1,5 +1,5 @@ -AnalyticsExportStatus | @bitmovin/api-sdk

Enumeration AnalyticsExportStatus

Export

Enumeration Members

ERROR +AnalyticsExportStatus | @bitmovin/api-sdk

Enumeration AnalyticsExportStatus

Export

Enumeration Members

ERROR FINISHED QUEUED STARTED -

Enumeration Members

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

QUEUED

QUEUED: "QUEUED"

STARTED

STARTED: "STARTED"

Settings

Member Visibility

Theme

On This Page

ERRORFINISHEDQUEUEDSTARTED
\ No newline at end of file +

Enumeration Members

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

QUEUED

QUEUED: "QUEUED"

STARTED

STARTED: "STARTED"

Settings

Member Visibility

Theme

On This Page

ERRORFINISHEDQUEUEDSTARTED
\ No newline at end of file diff --git a/docs/enums/AnalyticsExportType.html b/docs/enums/AnalyticsExportType.html index 308c3bf41..062fae608 100644 --- a/docs/enums/AnalyticsExportType.html +++ b/docs/enums/AnalyticsExportType.html @@ -1,3 +1,3 @@ -AnalyticsExportType | @bitmovin/api-sdk

Enumeration AnalyticsExportType

Export

Enumeration Members

ADS +AnalyticsExportType | @bitmovin/api-sdk

Enumeration AnalyticsExportType

Export

Enumeration Members

ADS SESSIONS -

Enumeration Members

ADS

ADS: "ADS"

SESSIONS

SESSIONS: "SESSIONS"

Settings

Member Visibility

Theme

On This Page

ADSSESSIONS
\ No newline at end of file +

Enumeration Members

ADS

ADS: "ADS"

SESSIONS

SESSIONS: "SESSIONS"

Settings

Member Visibility

Theme

On This Page

ADSSESSIONS
\ No newline at end of file diff --git a/docs/enums/AnalyticsHttpRequestType.html b/docs/enums/AnalyticsHttpRequestType.html index cd62fce71..9dc4df6cd 100644 --- a/docs/enums/AnalyticsHttpRequestType.html +++ b/docs/enums/AnalyticsHttpRequestType.html @@ -1,4 +1,4 @@ -AnalyticsHttpRequestType | @bitmovin/api-sdk

Enumeration AnalyticsHttpRequestType

Export

Enumeration Members

DRM_LICENSE_WIDEVINE_ +AnalyticsHttpRequestType | @bitmovin/api-sdk

Enumeration AnalyticsHttpRequestType

Export

Enumeration Members

DRM_LICENSE_WIDEVINE_ KEY_HLS_AES_ MANIFEST_DASH_ MANIFEST_HLS_MASTER_ @@ -10,4 +10,4 @@ MEDIA_THUMBNAILS_ MEDIA_VIDEO_ UNKNOWN -

Enumeration Members

DRM_LICENSE_WIDEVINE_

DRM_LICENSE_WIDEVINE_: "DRM_LICENSE_WIDEVINE,"

KEY_HLS_AES_

KEY_HLS_AES_: "KEY_HLS_AES,"

MANIFEST_DASH_

MANIFEST_DASH_: "MANIFEST_DASH,"

MANIFEST_HLS_MASTER_

MANIFEST_HLS_MASTER_: "MANIFEST_HLS_MASTER,"

MANIFEST_HLS_VARIANT_

MANIFEST_HLS_VARIANT_: "MANIFEST_HLS_VARIANT,"

MANIFEST_SMOOTH_

MANIFEST_SMOOTH_: "MANIFEST_SMOOTH,"

MEDIA_AUDIO_

MEDIA_AUDIO_: "MEDIA_AUDIO,"

MEDIA_PROGRESSIVE_

MEDIA_PROGRESSIVE_: "MEDIA_PROGRESSIVE,"

MEDIA_SUBTITLES_

MEDIA_SUBTITLES_: "MEDIA_SUBTITLES,"

MEDIA_THUMBNAILS_

MEDIA_THUMBNAILS_: "MEDIA_THUMBNAILS,"

MEDIA_VIDEO_

MEDIA_VIDEO_: "MEDIA_VIDEO,"

UNKNOWN

UNKNOWN: "UNKNOWN"

Settings

Member Visibility

Theme

On This Page

DRM_LICENSE_WIDEVINE_KEY_HLS_AES_MANIFEST_DASH_MANIFEST_HLS_MASTER_MANIFEST_HLS_VARIANT_MANIFEST_SMOOTH_MEDIA_AUDIO_MEDIA_PROGRESSIVE_MEDIA_SUBTITLES_MEDIA_THUMBNAILS_MEDIA_VIDEO_UNKNOWN
\ No newline at end of file +

Enumeration Members

DRM_LICENSE_WIDEVINE_

DRM_LICENSE_WIDEVINE_: "DRM_LICENSE_WIDEVINE,"

KEY_HLS_AES_

KEY_HLS_AES_: "KEY_HLS_AES,"

MANIFEST_DASH_

MANIFEST_DASH_: "MANIFEST_DASH,"

MANIFEST_HLS_MASTER_

MANIFEST_HLS_MASTER_: "MANIFEST_HLS_MASTER,"

MANIFEST_HLS_VARIANT_

MANIFEST_HLS_VARIANT_: "MANIFEST_HLS_VARIANT,"

MANIFEST_SMOOTH_

MANIFEST_SMOOTH_: "MANIFEST_SMOOTH,"

MEDIA_AUDIO_

MEDIA_AUDIO_: "MEDIA_AUDIO,"

MEDIA_PROGRESSIVE_

MEDIA_PROGRESSIVE_: "MEDIA_PROGRESSIVE,"

MEDIA_SUBTITLES_

MEDIA_SUBTITLES_: "MEDIA_SUBTITLES,"

MEDIA_THUMBNAILS_

MEDIA_THUMBNAILS_: "MEDIA_THUMBNAILS,"

MEDIA_VIDEO_

MEDIA_VIDEO_: "MEDIA_VIDEO,"

UNKNOWN

UNKNOWN: "UNKNOWN"

Settings

Member Visibility

Theme

On This Page

DRM_LICENSE_WIDEVINE_KEY_HLS_AES_MANIFEST_DASH_MANIFEST_HLS_MASTER_MANIFEST_HLS_VARIANT_MANIFEST_SMOOTH_MEDIA_AUDIO_MEDIA_PROGRESSIVE_MEDIA_SUBTITLES_MEDIA_THUMBNAILS_MEDIA_VIDEO_UNKNOWN
\ No newline at end of file diff --git a/docs/enums/AnalyticsInterval.html b/docs/enums/AnalyticsInterval.html index 093c7b419..305eaefa7 100644 --- a/docs/enums/AnalyticsInterval.html +++ b/docs/enums/AnalyticsInterval.html @@ -1,5 +1,5 @@ -AnalyticsInterval | @bitmovin/api-sdk

Enumeration AnalyticsInterval

Export

Enumeration Members

DAY +AnalyticsInterval | @bitmovin/api-sdk

Enumeration AnalyticsInterval

Export

Enumeration Members

DAY HOUR MINUTE MONTH -

Enumeration Members

DAY

DAY: "DAY"

HOUR

HOUR: "HOUR"

MINUTE

MINUTE: "MINUTE"

MONTH

MONTH: "MONTH"

Settings

Member Visibility

Theme

On This Page

DAYHOURMINUTEMONTH
\ No newline at end of file +

Enumeration Members

DAY

DAY: "DAY"

HOUR

HOUR: "HOUR"

MINUTE

MINUTE: "MINUTE"

MONTH

MONTH: "MONTH"

Settings

Member Visibility

Theme

On This Page

DAYHOURMINUTEMONTH
\ No newline at end of file diff --git a/docs/enums/AnalyticsOrder.html b/docs/enums/AnalyticsOrder.html index 1b856b4b7..dfef288c6 100644 --- a/docs/enums/AnalyticsOrder.html +++ b/docs/enums/AnalyticsOrder.html @@ -1,3 +1,3 @@ -AnalyticsOrder | @bitmovin/api-sdk

Enumeration AnalyticsOrder

Export

Enumeration Members

ASC +AnalyticsOrder | @bitmovin/api-sdk

Enumeration AnalyticsOrder

Export

Enumeration Members

ASC DESC -

Enumeration Members

ASC

ASC: "ASC"

DESC

DESC: "DESC"

Settings

Member Visibility

Theme

On This Page

ASCDESC
\ No newline at end of file +

Enumeration Members

ASC

ASC: "ASC"

DESC

DESC: "DESC"

Settings

Member Visibility

Theme

On This Page

ASCDESC
\ No newline at end of file diff --git a/docs/enums/AnalyticsOutputType.html b/docs/enums/AnalyticsOutputType.html index af78e923e..ab6676af3 100644 --- a/docs/enums/AnalyticsOutputType.html +++ b/docs/enums/AnalyticsOutputType.html @@ -1,4 +1,4 @@ -AnalyticsOutputType | @bitmovin/api-sdk

Enumeration AnalyticsOutputType

Export

Enumeration Members

AZURE +AnalyticsOutputType | @bitmovin/api-sdk

Enumeration AnalyticsOutputType

Export

Enumeration Members

AZURE GCS_SERVICE_ACCOUNT S3_ROLE_BASED -

Enumeration Members

AZURE

AZURE: "AZURE"

GCS_SERVICE_ACCOUNT

GCS_SERVICE_ACCOUNT: "GCS_SERVICE_ACCOUNT"

S3_ROLE_BASED

S3_ROLE_BASED: "S3_ROLE_BASED"

Settings

Member Visibility

Theme

On This Page

AZUREGCS_SERVICE_ACCOUNTS3_ROLE_BASED
\ No newline at end of file +

Enumeration Members

AZURE

AZURE: "AZURE"

GCS_SERVICE_ACCOUNT

GCS_SERVICE_ACCOUNT: "GCS_SERVICE_ACCOUNT"

S3_ROLE_BASED

S3_ROLE_BASED: "S3_ROLE_BASED"

Settings

Member Visibility

Theme

On This Page

AZUREGCS_SERVICE_ACCOUNTS3_ROLE_BASED
\ No newline at end of file diff --git a/docs/enums/AnalyticsQueryOperator.html b/docs/enums/AnalyticsQueryOperator.html index fbf05176f..7b72eb4c1 100644 --- a/docs/enums/AnalyticsQueryOperator.html +++ b/docs/enums/AnalyticsQueryOperator.html @@ -1,4 +1,4 @@ -AnalyticsQueryOperator | @bitmovin/api-sdk

Enumeration AnalyticsQueryOperator

Export

Enumeration Members

CONTAINS +AnalyticsQueryOperator | @bitmovin/api-sdk

Enumeration AnalyticsQueryOperator

Export

Enumeration Members

CONTAINS EQ GT GTE @@ -7,4 +7,4 @@ LTE NE NOTCONTAINS -

Enumeration Members

CONTAINS

CONTAINS: "CONTAINS"

EQ

EQ: "EQ"

GT

GT: "GT"

GTE

GTE: "GTE"

IN

IN: "IN"

LT

LT: "LT"

LTE

LTE: "LTE"

NE

NE: "NE"

NOTCONTAINS

NOTCONTAINS: "NOTCONTAINS"

Settings

Member Visibility

Theme

On This Page

CONTAINSEQGTGTEINLTLTENENOTCONTAINS
\ No newline at end of file +

Enumeration Members

CONTAINS

CONTAINS: "CONTAINS"

EQ

EQ: "EQ"

GT

GT: "GT"

GTE

GTE: "GTE"

IN

IN: "IN"

LT

LT: "LT"

LTE

LTE: "LTE"

NE

NE: "NE"

NOTCONTAINS

NOTCONTAINS: "NOTCONTAINS"

Settings

Member Visibility

Theme

On This Page

CONTAINSEQGTGTEINLTLTENENOTCONTAINS
\ No newline at end of file diff --git a/docs/enums/AspectMode.html b/docs/enums/AspectMode.html index a39dae588..5d173676c 100644 --- a/docs/enums/AspectMode.html +++ b/docs/enums/AspectMode.html @@ -1,4 +1,4 @@ -AspectMode | @bitmovin/api-sdk

Enumeration AspectMode

Export

Enumeration Members

CROP +AspectMode | @bitmovin/api-sdk

Enumeration AspectMode

Export

Enumeration Members

CROP PAD STRETCH -

Enumeration Members

CROP

CROP: "CROP"

PAD

PAD: "PAD"

STRETCH

STRETCH: "STRETCH"

Settings

Member Visibility

Theme

On This Page

CROPPADSTRETCH
\ No newline at end of file +

Enumeration Members

CROP

CROP: "CROP"

PAD

PAD: "PAD"

STRETCH

STRETCH: "STRETCH"

Settings

Member Visibility

Theme

On This Page

CROPPADSTRETCH
\ No newline at end of file diff --git a/docs/enums/AudioMixChannelLayout.html b/docs/enums/AudioMixChannelLayout.html index e276c2f28..4d979e03a 100644 --- a/docs/enums/AudioMixChannelLayout.html +++ b/docs/enums/AudioMixChannelLayout.html @@ -1,5 +1,5 @@ AudioMixChannelLayout | @bitmovin/api-sdk

Enumeration AudioMixChannelLayout

Channel layout of this audio mix

-

Export

Enumeration Members

CL_2_1 +

Export

Enumeration Members

CL_2_1 CL_2_2 CL_3_1 CL_4_0 @@ -26,4 +26,4 @@ CL_STEREO_DOWNMIX CL_SURROUND NONE -

Enumeration Members

CL_2_1

CL_2_1: "2.1"

CL_2_2

CL_2_2: "2.2"

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_5_1

CL_5_1: "5.1"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_6_0

CL_6_0: "6.0"

CL_6_0_FRONT

CL_6_0_FRONT: "6.0_FRONT"

CL_6_1

CL_6_1: "6.1"

CL_6_1_BACK

CL_6_1_BACK: "6.1_BACK"

CL_6_1_FRONT

CL_6_1_FRONT: "6.1_FRONT"

CL_7_0

CL_7_0: "7.0"

CL_7_0_FRONT

CL_7_0_FRONT: "7.0_FRONT"

CL_7_1

CL_7_1: "7.1"

CL_7_1_WIDE

CL_7_1_WIDE: "7.1_WIDE"

CL_7_1_WIDE_BACK

CL_7_1_WIDE_BACK: "7.1_WIDE_BACK"

CL_HEXAGONAL

CL_HEXAGONAL: "HEXAGONAL"

CL_MONO

CL_MONO: "MONO"

CL_OCTAGONAL

CL_OCTAGONAL: "OCTAGONAL"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_STEREO_DOWNMIX

CL_STEREO_DOWNMIX: "STEREO_DOWNMIX"

CL_SURROUND

CL_SURROUND: "SURROUND"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_2_1CL_2_2CL_3_1CL_4_0CL_4_1CL_5_0CL_5_0_BACKCL_5_1CL_5_1_BACKCL_6_0CL_6_0_FRONTCL_6_1CL_6_1_BACKCL_6_1_FRONTCL_7_0CL_7_0_FRONTCL_7_1CL_7_1_WIDECL_7_1_WIDE_BACKCL_HEXAGONALCL_MONOCL_OCTAGONALCL_QUADCL_STEREOCL_STEREO_DOWNMIXCL_SURROUNDNONE
\ No newline at end of file +

Enumeration Members

CL_2_1

CL_2_1: "2.1"

CL_2_2

CL_2_2: "2.2"

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_5_1

CL_5_1: "5.1"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_6_0

CL_6_0: "6.0"

CL_6_0_FRONT

CL_6_0_FRONT: "6.0_FRONT"

CL_6_1

CL_6_1: "6.1"

CL_6_1_BACK

CL_6_1_BACK: "6.1_BACK"

CL_6_1_FRONT

CL_6_1_FRONT: "6.1_FRONT"

CL_7_0

CL_7_0: "7.0"

CL_7_0_FRONT

CL_7_0_FRONT: "7.0_FRONT"

CL_7_1

CL_7_1: "7.1"

CL_7_1_WIDE

CL_7_1_WIDE: "7.1_WIDE"

CL_7_1_WIDE_BACK

CL_7_1_WIDE_BACK: "7.1_WIDE_BACK"

CL_HEXAGONAL

CL_HEXAGONAL: "HEXAGONAL"

CL_MONO

CL_MONO: "MONO"

CL_OCTAGONAL

CL_OCTAGONAL: "OCTAGONAL"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_STEREO_DOWNMIX

CL_STEREO_DOWNMIX: "STEREO_DOWNMIX"

CL_SURROUND

CL_SURROUND: "SURROUND"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_2_1CL_2_2CL_3_1CL_4_0CL_4_1CL_5_0CL_5_0_BACKCL_5_1CL_5_1_BACKCL_6_0CL_6_0_FRONTCL_6_1CL_6_1_BACKCL_6_1_FRONTCL_7_0CL_7_0_FRONTCL_7_1CL_7_1_WIDECL_7_1_WIDE_BACKCL_HEXAGONALCL_MONOCL_OCTAGONALCL_QUADCL_STEREOCL_STEREO_DOWNMIXCL_SURROUNDNONE
\ No newline at end of file diff --git a/docs/enums/AudioMixChannelType.html b/docs/enums/AudioMixChannelType.html index 16f98ff89..ce7a147ca 100644 --- a/docs/enums/AudioMixChannelType.html +++ b/docs/enums/AudioMixChannelType.html @@ -1,5 +1,5 @@ AudioMixChannelType | @bitmovin/api-sdk

Enumeration AudioMixChannelType

Type of this channel

-

Export

Enumeration Members

BACK_LEFT +

Export

Enumeration Members

BACK_LEFT BACK_RIGHT CENTER CHANNEL_NUMBER @@ -8,4 +8,4 @@ LOW_FREQUENCY SURROUND_LEFT SURROUND_RIGHT -

Enumeration Members

BACK_LEFT

BACK_LEFT: "BACK_LEFT"

BACK_RIGHT

BACK_RIGHT: "BACK_RIGHT"

CENTER

CENTER: "CENTER"

CHANNEL_NUMBER

CHANNEL_NUMBER: "CHANNEL_NUMBER"

FRONT_LEFT

FRONT_LEFT: "FRONT_LEFT"

FRONT_RIGHT

FRONT_RIGHT: "FRONT_RIGHT"

LOW_FREQUENCY

LOW_FREQUENCY: "LOW_FREQUENCY"

SURROUND_LEFT

SURROUND_LEFT: "SURROUND_LEFT"

SURROUND_RIGHT

SURROUND_RIGHT: "SURROUND_RIGHT"

Settings

Member Visibility

Theme

On This Page

BACK_LEFTBACK_RIGHTCENTERCHANNEL_NUMBERFRONT_LEFTFRONT_RIGHTLOW_FREQUENCYSURROUND_LEFTSURROUND_RIGHT
\ No newline at end of file +

Enumeration Members

BACK_LEFT

BACK_LEFT: "BACK_LEFT"

BACK_RIGHT

BACK_RIGHT: "BACK_RIGHT"

CENTER

CENTER: "CENTER"

CHANNEL_NUMBER

CHANNEL_NUMBER: "CHANNEL_NUMBER"

FRONT_LEFT

FRONT_LEFT: "FRONT_LEFT"

FRONT_RIGHT

FRONT_RIGHT: "FRONT_RIGHT"

LOW_FREQUENCY

LOW_FREQUENCY: "LOW_FREQUENCY"

SURROUND_LEFT

SURROUND_LEFT: "SURROUND_LEFT"

SURROUND_RIGHT

SURROUND_RIGHT: "SURROUND_RIGHT"

Settings

Member Visibility

Theme

On This Page

BACK_LEFTBACK_RIGHTCENTERCHANNEL_NUMBERFRONT_LEFTFRONT_RIGHTLOW_FREQUENCYSURROUND_LEFTSURROUND_RIGHT
\ No newline at end of file diff --git a/docs/enums/AudioMixInputChannelLayout.html b/docs/enums/AudioMixInputChannelLayout.html index fec2acbe2..2f999801b 100644 --- a/docs/enums/AudioMixInputChannelLayout.html +++ b/docs/enums/AudioMixInputChannelLayout.html @@ -1,4 +1,4 @@ -AudioMixInputChannelLayout | @bitmovin/api-sdk

Enumeration AudioMixInputChannelLayout

Export

Enumeration Members

CL_2_1 +AudioMixInputChannelLayout | @bitmovin/api-sdk

Enumeration AudioMixInputChannelLayout

Export

Enumeration Members

CL_2_1 CL_2_2 CL_3_1 CL_4_0 @@ -25,4 +25,4 @@ CL_SURROUND MONO NONE -

Enumeration Members

CL_2_1

CL_2_1: "2.1"

CL_2_2

CL_2_2: "2.2"

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_5_1

CL_5_1: "5.1"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_6_0

CL_6_0: "6.0"

CL_6_0_FRONT

CL_6_0_FRONT: "6.0_FRONT"

CL_6_1

CL_6_1: "6.1"

CL_6_1_BACK

CL_6_1_BACK: "6.1_BACK"

CL_6_1_FRONT

CL_6_1_FRONT: "6.1_FRONT"

CL_7_0

CL_7_0: "7.0"

CL_7_0_FRONT

CL_7_0_FRONT: "7.0_FRONT"

CL_7_1

CL_7_1: "7.1"

CL_7_1_WIDE

CL_7_1_WIDE: "7.1_WIDE"

CL_7_1_WIDE_BACK

CL_7_1_WIDE_BACK: "7.1_WIDE_BACK"

CL_HEXAGONAL

CL_HEXAGONAL: "HEXAGONAL"

CL_OCTAGONAL

CL_OCTAGONAL: "OCTAGONAL"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_STEREO_DOWNMIX

CL_STEREO_DOWNMIX: "STEREO_DOWNMIX"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_2_1CL_2_2CL_3_1CL_4_0CL_4_1CL_5_0CL_5_0_BACKCL_5_1CL_5_1_BACKCL_6_0CL_6_0_FRONTCL_6_1CL_6_1_BACKCL_6_1_FRONTCL_7_0CL_7_0_FRONTCL_7_1CL_7_1_WIDECL_7_1_WIDE_BACKCL_HEXAGONALCL_OCTAGONALCL_QUADCL_STEREOCL_STEREO_DOWNMIXCL_SURROUNDMONONONE
\ No newline at end of file +

Enumeration Members

CL_2_1

CL_2_1: "2.1"

CL_2_2

CL_2_2: "2.2"

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_5_1

CL_5_1: "5.1"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_6_0

CL_6_0: "6.0"

CL_6_0_FRONT

CL_6_0_FRONT: "6.0_FRONT"

CL_6_1

CL_6_1: "6.1"

CL_6_1_BACK

CL_6_1_BACK: "6.1_BACK"

CL_6_1_FRONT

CL_6_1_FRONT: "6.1_FRONT"

CL_7_0

CL_7_0: "7.0"

CL_7_0_FRONT

CL_7_0_FRONT: "7.0_FRONT"

CL_7_1

CL_7_1: "7.1"

CL_7_1_WIDE

CL_7_1_WIDE: "7.1_WIDE"

CL_7_1_WIDE_BACK

CL_7_1_WIDE_BACK: "7.1_WIDE_BACK"

CL_HEXAGONAL

CL_HEXAGONAL: "HEXAGONAL"

CL_OCTAGONAL

CL_OCTAGONAL: "OCTAGONAL"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_STEREO_DOWNMIX

CL_STEREO_DOWNMIX: "STEREO_DOWNMIX"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_2_1CL_2_2CL_3_1CL_4_0CL_4_1CL_5_0CL_5_0_BACKCL_5_1CL_5_1_BACKCL_6_0CL_6_0_FRONTCL_6_1CL_6_1_BACKCL_6_1_FRONTCL_7_0CL_7_0_FRONTCL_7_1CL_7_1_WIDECL_7_1_WIDE_BACKCL_HEXAGONALCL_OCTAGONALCL_QUADCL_STEREOCL_STEREO_DOWNMIXCL_SURROUNDMONONONE
\ No newline at end of file diff --git a/docs/enums/AudioMixSourceChannelType.html b/docs/enums/AudioMixSourceChannelType.html index 8d5c5060d..97486a087 100644 --- a/docs/enums/AudioMixSourceChannelType.html +++ b/docs/enums/AudioMixSourceChannelType.html @@ -1,5 +1,5 @@ AudioMixSourceChannelType | @bitmovin/api-sdk

Enumeration AudioMixSourceChannelType

Type of this source channel

-

Export

Enumeration Members

BACK_LEFT +

Export

Enumeration Members

BACK_LEFT BACK_RIGHT CENTER CHANNEL_NUMBER @@ -8,4 +8,4 @@ LOW_FREQUENCY SURROUND_LEFT SURROUND_RIGHT -

Enumeration Members

BACK_LEFT

BACK_LEFT: "BACK_LEFT"

BACK_RIGHT

BACK_RIGHT: "BACK_RIGHT"

CENTER

CENTER: "CENTER"

CHANNEL_NUMBER

CHANNEL_NUMBER: "CHANNEL_NUMBER"

FRONT_LEFT

FRONT_LEFT: "FRONT_LEFT"

FRONT_RIGHT

FRONT_RIGHT: "FRONT_RIGHT"

LOW_FREQUENCY

LOW_FREQUENCY: "LOW_FREQUENCY"

SURROUND_LEFT

SURROUND_LEFT: "SURROUND_LEFT"

SURROUND_RIGHT

SURROUND_RIGHT: "SURROUND_RIGHT"

Settings

Member Visibility

Theme

On This Page

BACK_LEFTBACK_RIGHTCENTERCHANNEL_NUMBERFRONT_LEFTFRONT_RIGHTLOW_FREQUENCYSURROUND_LEFTSURROUND_RIGHT
\ No newline at end of file +

Enumeration Members

BACK_LEFT

BACK_LEFT: "BACK_LEFT"

BACK_RIGHT

BACK_RIGHT: "BACK_RIGHT"

CENTER

CENTER: "CENTER"

CHANNEL_NUMBER

CHANNEL_NUMBER: "CHANNEL_NUMBER"

FRONT_LEFT

FRONT_LEFT: "FRONT_LEFT"

FRONT_RIGHT

FRONT_RIGHT: "FRONT_RIGHT"

LOW_FREQUENCY

LOW_FREQUENCY: "LOW_FREQUENCY"

SURROUND_LEFT

SURROUND_LEFT: "SURROUND_LEFT"

SURROUND_RIGHT

SURROUND_RIGHT: "SURROUND_RIGHT"

Settings

Member Visibility

Theme

On This Page

BACK_LEFTBACK_RIGHTCENTERCHANNEL_NUMBERFRONT_LEFTFRONT_RIGHTLOW_FREQUENCYSURROUND_LEFTSURROUND_RIGHT
\ No newline at end of file diff --git a/docs/enums/AudioVideoSyncMode.html b/docs/enums/AudioVideoSyncMode.html index cb38bf7d7..67bf72029 100644 --- a/docs/enums/AudioVideoSyncMode.html +++ b/docs/enums/AudioVideoSyncMode.html @@ -1,4 +1,4 @@ -AudioVideoSyncMode | @bitmovin/api-sdk

Enumeration AudioVideoSyncMode

Export

Enumeration Members

RESYNC_AT_START +AudioVideoSyncMode | @bitmovin/api-sdk

Enumeration AudioVideoSyncMode

Export

Enumeration Members

RESYNC_AT_START RESYNC_AT_START_AND_END STANDARD -

Enumeration Members

RESYNC_AT_START

RESYNC_AT_START: "RESYNC_AT_START"

RESYNC_AT_START_AND_END

RESYNC_AT_START_AND_END: "RESYNC_AT_START_AND_END"

STANDARD

STANDARD: "STANDARD"

Settings

Member Visibility

Theme

On This Page

RESYNC_AT_STARTRESYNC_AT_START_AND_ENDSTANDARD
\ No newline at end of file +

Enumeration Members

RESYNC_AT_START

RESYNC_AT_START: "RESYNC_AT_START"

RESYNC_AT_START_AND_END

RESYNC_AT_START_AND_END: "RESYNC_AT_START_AND_END"

STANDARD

STANDARD: "STANDARD"

Settings

Member Visibility

Theme

On This Page

RESYNC_AT_STARTRESYNC_AT_START_AND_ENDSTANDARD
\ No newline at end of file diff --git a/docs/enums/AudioVolumeFormat.html b/docs/enums/AudioVolumeFormat.html index b11c5d37b..927c5e987 100644 --- a/docs/enums/AudioVolumeFormat.html +++ b/docs/enums/AudioVolumeFormat.html @@ -1,5 +1,5 @@ AudioVolumeFormat | @bitmovin/api-sdk

Enumeration AudioVolumeFormat

Audio volume format

-

Export

Enumeration Members

DBL +

Export

Enumeration Members

DBL DBLP FLT FLTP @@ -12,4 +12,4 @@ S64P U8 U8P -

Enumeration Members

DBL

DBL: "DBL"

DBLP

DBLP: "DBLP"

FLT

FLT: "FLT"

FLTP

FLTP: "FLTP"

NONE

NONE: "NONE"

S16

S16: "S16"

S16P

S16P: "S16P"

S32

S32: "S32"

S32P

S32P: "S32P"

S64

S64: "S64"

S64P

S64P: "S64P"

U8

U8: "U8"

U8P

U8P: "U8P"

Settings

Member Visibility

Theme

On This Page

DBLDBLPFLTFLTPNONES16S16PS32S32PS64S64PU8U8P
\ No newline at end of file +

Enumeration Members

DBL

DBL: "DBL"

DBLP

DBLP: "DBLP"

FLT

FLT: "FLT"

FLTP

FLTP: "FLTP"

NONE

NONE: "NONE"

S16

S16: "S16"

S16P

S16P: "S16P"

S32

S32: "S32"

S32P

S32P: "S32P"

S64

S64: "S64"

S64P

S64P: "S64P"

U8

U8: "U8"

U8P

U8P: "U8P"

Settings

Member Visibility

Theme

On This Page

DBLDBLPFLTFLTPNONES16S16PS32S32PS64S64PU8U8P
\ No newline at end of file diff --git a/docs/enums/AudioVolumeUnit.html b/docs/enums/AudioVolumeUnit.html index a98c53964..e138dc579 100644 --- a/docs/enums/AudioVolumeUnit.html +++ b/docs/enums/AudioVolumeUnit.html @@ -1,4 +1,4 @@ AudioVolumeUnit | @bitmovin/api-sdk

Enumeration AudioVolumeUnit

The unit in which the audio volume should be changed

-

Export

Enumeration Members

DB +

Export

Enumeration Members

DB PERCENT -

Enumeration Members

DB

DB: "DB"

PERCENT

PERCENT: "PERCENT"

Settings

Member Visibility

Theme

On This Page

DBPERCENT
\ No newline at end of file +

Enumeration Members

DB

DB: "DB"

PERCENT

PERCENT: "PERCENT"

Settings

Member Visibility

Theme

On This Page

DBPERCENT
\ No newline at end of file diff --git a/docs/enums/AutoLevelSetup.html b/docs/enums/AutoLevelSetup.html index 0baa75baa..68f131de9 100644 --- a/docs/enums/AutoLevelSetup.html +++ b/docs/enums/AutoLevelSetup.html @@ -1,4 +1,4 @@ AutoLevelSetup | @bitmovin/api-sdk

Enumeration AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate.

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/Av1PresetConfiguration.html b/docs/enums/Av1PresetConfiguration.html index 5f600b723..0f1475799 100644 --- a/docs/enums/Av1PresetConfiguration.html +++ b/docs/enums/Av1PresetConfiguration.html @@ -1,4 +1,4 @@ -Av1PresetConfiguration | @bitmovin/api-sdk

Enumeration Av1PresetConfiguration

Export

Enumeration Members

VOD_QUALITY +Av1PresetConfiguration | @bitmovin/api-sdk

Enumeration Av1PresetConfiguration

Export

Enumeration Members

VOD_QUALITY VOD_SPEED VOD_STANDARD -

Enumeration Members

VOD_QUALITY

VOD_QUALITY: "VOD_QUALITY"

VOD_SPEED

VOD_SPEED: "VOD_SPEED"

VOD_STANDARD

VOD_STANDARD: "VOD_STANDARD"

Settings

Member Visibility

Theme

On This Page

VOD_QUALITYVOD_SPEEDVOD_STANDARD
\ No newline at end of file +

Enumeration Members

VOD_QUALITY

VOD_QUALITY: "VOD_QUALITY"

VOD_SPEED

VOD_SPEED: "VOD_SPEED"

VOD_STANDARD

VOD_STANDARD: "VOD_STANDARD"

Settings

Member Visibility

Theme

On This Page

VOD_QUALITYVOD_SPEEDVOD_STANDARD
\ No newline at end of file diff --git a/docs/enums/AvailabilityStartTimeMode.html b/docs/enums/AvailabilityStartTimeMode.html index 1e898b466..1ac6a49f7 100644 --- a/docs/enums/AvailabilityStartTimeMode.html +++ b/docs/enums/AvailabilityStartTimeMode.html @@ -1,3 +1,3 @@ -AvailabilityStartTimeMode | @bitmovin/api-sdk

Enumeration AvailabilityStartTimeMode

Export

Enumeration Members

ON_FIRST_SEGMENT +AvailabilityStartTimeMode | @bitmovin/api-sdk

Enumeration AvailabilityStartTimeMode

Export

Enumeration Members

ON_FIRST_SEGMENT ON_STREAM_INGEST -

Enumeration Members

ON_FIRST_SEGMENT

ON_FIRST_SEGMENT: "ON_FIRST_SEGMENT"

ON_STREAM_INGEST

ON_STREAM_INGEST: "ON_STREAM_INGEST"

Settings

Member Visibility

Theme

On This Page

ON_FIRST_SEGMENTON_STREAM_INGEST
\ No newline at end of file +

Enumeration Members

ON_FIRST_SEGMENT

ON_FIRST_SEGMENT: "ON_FIRST_SEGMENT"

ON_STREAM_INGEST

ON_STREAM_INGEST: "ON_STREAM_INGEST"

Settings

Member Visibility

Theme

On This Page

ON_FIRST_SEGMENTON_STREAM_INGEST
\ No newline at end of file diff --git a/docs/enums/AwsCloudRegion.html b/docs/enums/AwsCloudRegion.html index 08596eb64..fa4dea55d 100644 --- a/docs/enums/AwsCloudRegion.html +++ b/docs/enums/AwsCloudRegion.html @@ -1,4 +1,4 @@ -AwsCloudRegion | @bitmovin/api-sdk

Enumeration AwsCloudRegion

Export

Enumeration Members

AP_NORTHEAST_1 +AwsCloudRegion | @bitmovin/api-sdk

Enumeration AwsCloudRegion

Export

Enumeration Members

AP_NORTHEAST_1 AP_NORTHEAST_2 AP_SOUTHEAST_1 AP_SOUTHEAST_2 @@ -14,4 +14,4 @@ US_EAST_2 US_WEST_1 US_WEST_2 -

Enumeration Members

AP_NORTHEAST_1

AP_NORTHEAST_1: "AP_NORTHEAST_1"

AP_NORTHEAST_2

AP_NORTHEAST_2: "AP_NORTHEAST_2"

AP_SOUTHEAST_1

AP_SOUTHEAST_1: "AP_SOUTHEAST_1"

AP_SOUTHEAST_2

AP_SOUTHEAST_2: "AP_SOUTHEAST_2"

AP_SOUTH_1

AP_SOUTH_1: "AP_SOUTH_1"

CA_CENTRAL_1

CA_CENTRAL_1: "CA_CENTRAL_1"

EU_CENTRAL_1

EU_CENTRAL_1: "EU_CENTRAL_1"

EU_NORTH_1

EU_NORTH_1: "EU_NORTH_1"

EU_WEST_1

EU_WEST_1: "EU_WEST_1"

EU_WEST_2

EU_WEST_2: "EU_WEST_2"

EU_WEST_3

EU_WEST_3: "EU_WEST_3"

SA_EAST_1

SA_EAST_1: "SA_EAST_1"

US_EAST_1

US_EAST_1: "US_EAST_1"

US_EAST_2

US_EAST_2: "US_EAST_2"

US_WEST_1

US_WEST_1: "US_WEST_1"

US_WEST_2

US_WEST_2: "US_WEST_2"

Settings

Member Visibility

Theme

On This Page

AP_NORTHEAST_1AP_NORTHEAST_2AP_SOUTHEAST_1AP_SOUTHEAST_2AP_SOUTH_1CA_CENTRAL_1EU_CENTRAL_1EU_NORTH_1EU_WEST_1EU_WEST_2EU_WEST_3SA_EAST_1US_EAST_1US_EAST_2US_WEST_1US_WEST_2
\ No newline at end of file +

Enumeration Members

AP_NORTHEAST_1

AP_NORTHEAST_1: "AP_NORTHEAST_1"

AP_NORTHEAST_2

AP_NORTHEAST_2: "AP_NORTHEAST_2"

AP_SOUTHEAST_1

AP_SOUTHEAST_1: "AP_SOUTHEAST_1"

AP_SOUTHEAST_2

AP_SOUTHEAST_2: "AP_SOUTHEAST_2"

AP_SOUTH_1

AP_SOUTH_1: "AP_SOUTH_1"

CA_CENTRAL_1

CA_CENTRAL_1: "CA_CENTRAL_1"

EU_CENTRAL_1

EU_CENTRAL_1: "EU_CENTRAL_1"

EU_NORTH_1

EU_NORTH_1: "EU_NORTH_1"

EU_WEST_1

EU_WEST_1: "EU_WEST_1"

EU_WEST_2

EU_WEST_2: "EU_WEST_2"

EU_WEST_3

EU_WEST_3: "EU_WEST_3"

SA_EAST_1

SA_EAST_1: "SA_EAST_1"

US_EAST_1

US_EAST_1: "US_EAST_1"

US_EAST_2

US_EAST_2: "US_EAST_2"

US_WEST_1

US_WEST_1: "US_WEST_1"

US_WEST_2

US_WEST_2: "US_WEST_2"

Settings

Member Visibility

Theme

On This Page

AP_NORTHEAST_1AP_NORTHEAST_2AP_SOUTHEAST_1AP_SOUTHEAST_2AP_SOUTH_1CA_CENTRAL_1EU_CENTRAL_1EU_NORTH_1EU_WEST_1EU_WEST_2EU_WEST_3SA_EAST_1US_EAST_1US_EAST_2US_WEST_1US_WEST_2
\ No newline at end of file diff --git a/docs/enums/AzureCloudRegion.html b/docs/enums/AzureCloudRegion.html index c2bd1c7da..114657218 100644 --- a/docs/enums/AzureCloudRegion.html +++ b/docs/enums/AzureCloudRegion.html @@ -1,4 +1,4 @@ -AzureCloudRegion | @bitmovin/api-sdk

Enumeration AzureCloudRegion

Export

Enumeration Members

ASIA_EAST +AzureCloudRegion | @bitmovin/api-sdk

Enumeration AzureCloudRegion

Export

Enumeration Members

ASIA_EAST ASIA_SOUTHEAST AUSTRALIA_EAST AUSTRALIA_SOUTHEAST @@ -22,4 +22,4 @@ US_SOUTH_CENTRAL US_WEST US_WEST2 -

Enumeration Members

ASIA_EAST

ASIA_EAST: "ASIA_EAST"

ASIA_SOUTHEAST

ASIA_SOUTHEAST: "ASIA_SOUTHEAST"

AUSTRALIA_EAST

AUSTRALIA_EAST: "AUSTRALIA_EAST"

AUSTRALIA_SOUTHEAST

AUSTRALIA_SOUTHEAST: "AUSTRALIA_SOUTHEAST"

BRAZIL_SOUTH

BRAZIL_SOUTH: "BRAZIL_SOUTH"

CANADA_CENTRAL

CANADA_CENTRAL: "CANADA_CENTRAL"

EUROPE_NORTH

EUROPE_NORTH: "EUROPE_NORTH"

EUROPE_WEST

EUROPE_WEST: "EUROPE_WEST"

FRANCE_CENTRAL

FRANCE_CENTRAL: "FRANCE_CENTRAL"

GERMANY_WESTCENTRAL

GERMANY_WESTCENTRAL: "GERMANY_WESTCENTRAL"

INDIA_CENTRAL

INDIA_CENTRAL: "INDIA_CENTRAL"

INDIA_SOUTH

INDIA_SOUTH: "INDIA_SOUTH"

JAPAN_EAST

JAPAN_EAST: "JAPAN_EAST"

JAPAN_WEST

JAPAN_WEST: "JAPAN_WEST"

KOREA_CENTRAL

KOREA_CENTRAL: "KOREA_CENTRAL"

UAE_NORTH

UAE_NORTH: "UAE_NORTH"

UK_SOUTH

UK_SOUTH: "UK_SOUTH"

US_CENTRAL

US_CENTRAL: "US_CENTRAL"

US_EAST

US_EAST: "US_EAST"

US_EAST2

US_EAST2: "US_EAST2"

US_NORTH_CENTRAL

US_NORTH_CENTRAL: "US_NORTH_CENTRAL"

US_SOUTH_CENTRAL

US_SOUTH_CENTRAL: "US_SOUTH_CENTRAL"

US_WEST

US_WEST: "US_WEST"

US_WEST2

US_WEST2: "US_WEST2"

Settings

Member Visibility

Theme

On This Page

ASIA_EASTASIA_SOUTHEASTAUSTRALIA_EASTAUSTRALIA_SOUTHEASTBRAZIL_SOUTHCANADA_CENTRALEUROPE_NORTHEUROPE_WESTFRANCE_CENTRALGERMANY_WESTCENTRALINDIA_CENTRALINDIA_SOUTHJAPAN_EASTJAPAN_WESTKOREA_CENTRALUAE_NORTHUK_SOUTHUS_CENTRALUS_EASTUS_EAST2US_NORTH_CENTRALUS_SOUTH_CENTRALUS_WESTUS_WEST2
\ No newline at end of file +

Enumeration Members

ASIA_EAST

ASIA_EAST: "ASIA_EAST"

ASIA_SOUTHEAST

ASIA_SOUTHEAST: "ASIA_SOUTHEAST"

AUSTRALIA_EAST

AUSTRALIA_EAST: "AUSTRALIA_EAST"

AUSTRALIA_SOUTHEAST

AUSTRALIA_SOUTHEAST: "AUSTRALIA_SOUTHEAST"

BRAZIL_SOUTH

BRAZIL_SOUTH: "BRAZIL_SOUTH"

CANADA_CENTRAL

CANADA_CENTRAL: "CANADA_CENTRAL"

EUROPE_NORTH

EUROPE_NORTH: "EUROPE_NORTH"

EUROPE_WEST

EUROPE_WEST: "EUROPE_WEST"

FRANCE_CENTRAL

FRANCE_CENTRAL: "FRANCE_CENTRAL"

GERMANY_WESTCENTRAL

GERMANY_WESTCENTRAL: "GERMANY_WESTCENTRAL"

INDIA_CENTRAL

INDIA_CENTRAL: "INDIA_CENTRAL"

INDIA_SOUTH

INDIA_SOUTH: "INDIA_SOUTH"

JAPAN_EAST

JAPAN_EAST: "JAPAN_EAST"

JAPAN_WEST

JAPAN_WEST: "JAPAN_WEST"

KOREA_CENTRAL

KOREA_CENTRAL: "KOREA_CENTRAL"

UAE_NORTH

UAE_NORTH: "UAE_NORTH"

UK_SOUTH

UK_SOUTH: "UK_SOUTH"

US_CENTRAL

US_CENTRAL: "US_CENTRAL"

US_EAST

US_EAST: "US_EAST"

US_EAST2

US_EAST2: "US_EAST2"

US_NORTH_CENTRAL

US_NORTH_CENTRAL: "US_NORTH_CENTRAL"

US_SOUTH_CENTRAL

US_SOUTH_CENTRAL: "US_SOUTH_CENTRAL"

US_WEST

US_WEST: "US_WEST"

US_WEST2

US_WEST2: "US_WEST2"

Settings

Member Visibility

Theme

On This Page

ASIA_EASTASIA_SOUTHEASTAUSTRALIA_EASTAUSTRALIA_SOUTHEASTBRAZIL_SOUTHCANADA_CENTRALEUROPE_NORTHEUROPE_WESTFRANCE_CENTRALGERMANY_WESTCENTRALINDIA_CENTRALINDIA_SOUTHJAPAN_EASTJAPAN_WESTKOREA_CENTRALUAE_NORTHUK_SOUTHUS_CENTRALUS_EASTUS_EAST2US_NORTH_CENTRALUS_SOUTH_CENTRALUS_WESTUS_WEST2
\ No newline at end of file diff --git a/docs/enums/AzureSpeechToCaptionsProfanity.html b/docs/enums/AzureSpeechToCaptionsProfanity.html index 60016f4b1..1ca9408e6 100644 --- a/docs/enums/AzureSpeechToCaptionsProfanity.html +++ b/docs/enums/AzureSpeechToCaptionsProfanity.html @@ -1,4 +1,4 @@ -AzureSpeechToCaptionsProfanity | @bitmovin/api-sdk

Enumeration AzureSpeechToCaptionsProfanity

Export

Enumeration Members

MASKED +AzureSpeechToCaptionsProfanity | @bitmovin/api-sdk

Enumeration AzureSpeechToCaptionsProfanity

Export

Enumeration Members

MASKED RAW REMOVED -

Enumeration Members

MASKED

MASKED: "MASKED"

RAW

RAW: "RAW"

REMOVED

REMOVED: "REMOVED"

Settings

Member Visibility

Theme

On This Page

MASKEDRAWREMOVED
\ No newline at end of file +

Enumeration Members

MASKED

MASKED: "MASKED"

RAW

RAW: "RAW"

REMOVED

REMOVED: "REMOVED"

Settings

Member Visibility

Theme

On This Page

MASKEDRAWREMOVED
\ No newline at end of file diff --git a/docs/enums/BAdapt.html b/docs/enums/BAdapt.html index e9ba672a7..b8ee4b659 100644 --- a/docs/enums/BAdapt.html +++ b/docs/enums/BAdapt.html @@ -1,4 +1,4 @@ -BAdapt | @bitmovin/api-sdk

Enumeration BAdapt

Export

Enumeration Members

FAST +BAdapt | @bitmovin/api-sdk

Enumeration BAdapt

Export

Enumeration Members

FAST FULL NONE -

Enumeration Members

FAST

FAST: "FAST"

FULL

FULL: "FULL"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

FASTFULLNONE
\ No newline at end of file +

Enumeration Members

FAST

FAST: "FAST"

FULL

FULL: "FULL"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

FASTFULLNONE
\ No newline at end of file diff --git a/docs/enums/BitrateSelectionMode.html b/docs/enums/BitrateSelectionMode.html index dea5cf189..f772ce012 100644 --- a/docs/enums/BitrateSelectionMode.html +++ b/docs/enums/BitrateSelectionMode.html @@ -1,3 +1,3 @@ -BitrateSelectionMode | @bitmovin/api-sdk

Enumeration BitrateSelectionMode

Export

Enumeration Members

COMPLEXITY_RANGE +BitrateSelectionMode | @bitmovin/api-sdk

Enumeration BitrateSelectionMode

Export

Enumeration Members

COMPLEXITY_RANGE OPTIMIZED -

Enumeration Members

COMPLEXITY_RANGE

COMPLEXITY_RANGE: "COMPLEXITY_RANGE"

OPTIMIZED

OPTIMIZED: "OPTIMIZED"

Settings

Member Visibility

Theme

On This Page

COMPLEXITY_RANGEOPTIMIZED
\ No newline at end of file +

Enumeration Members

COMPLEXITY_RANGE

COMPLEXITY_RANGE: "COMPLEXITY_RANGE"

OPTIMIZED

OPTIMIZED: "OPTIMIZED"

Settings

Member Visibility

Theme

On This Page

COMPLEXITY_RANGEOPTIMIZED
\ No newline at end of file diff --git a/docs/enums/CaptionCharacterEncoding.html b/docs/enums/CaptionCharacterEncoding.html index 8c22d3f4e..cbe88a4da 100644 --- a/docs/enums/CaptionCharacterEncoding.html +++ b/docs/enums/CaptionCharacterEncoding.html @@ -1,5 +1,5 @@ CaptionCharacterEncoding | @bitmovin/api-sdk

Enumeration CaptionCharacterEncoding

Character encoding of the SRT file

-

Export

Enumeration Members

ANSI_X3_4_1968 +

Export

Enumeration Members

ANSI_X3_4_1968 ANSI_X3_4_1986 ARABIC ARMSCII_8 @@ -327,4 +327,4 @@ X0201 X0208 X0212 -

Enumeration Members

ANSI_X3_4_1968

ANSI_X3_4_1968: "ANSI_X3.4-1968"

ANSI_X3_4_1986

ANSI_X3_4_1986: "ANSI_X3.4-1986"

ARABIC

ARABIC: "ARABIC"

ARMSCII_8

ARMSCII_8: "ARMSCII-8"

ASCII

ASCII: "ASCII"

ASMO_708

ASMO_708: "ASMO-708"

BIG5

BIG5: "BIG5"

BIG5HKSCS

BIG5HKSCS: "BIG5HKSCS"

BIG5_HKSCS

BIG5_HKSCS: "BIG5-HKSCS"

BIG5_HKSCS_1999

BIG5_HKSCS_1999: "BIG5-HKSCS:1999"

BIG5_HKSCS_2001

BIG5_HKSCS_2001: "BIG5-HKSCS:2001"

BIG5_HKSCS_2004

BIG5_HKSCS_2004: "BIG5-HKSCS:2004"

BIG5_HKSCS_2008

BIG5_HKSCS_2008: "BIG5-HKSCS:2008"

BIGFIVE

BIGFIVE: "BIGFIVE"

BIG_5

BIG_5: "BIG-5"

BIG_FIVE

BIG_FIVE: "BIG-FIVE"

C99

C99: "C99"

CHAR

CHAR: "CHAR"

CHINESE

CHINESE: "CHINESE"

CN

CN: "CN"

CN_BIG5

CN_BIG5: "CN-BIG5"

CN_GB

CN_GB: "CN-GB"

CN_GB_ISOIR165

CN_GB_ISOIR165: "CN-GB-ISOIR165"

CP1131

CP1131: "CP1131"

CP1133

CP1133: "CP1133"

CP1250

CP1250: "CP1250"

CP1251

CP1251: "CP1251"

CP1252

CP1252: "CP1252"

CP1253

CP1253: "CP1253"

CP1254

CP1254: "CP1254"

CP1255

CP1255: "CP1255"

CP1256

CP1256: "CP1256"

CP1257

CP1257: "CP1257"

CP1258

CP1258: "CP1258"

CP1361

CP1361: "CP1361"

CP154

CP154: "CP154"

CP367

CP367: "CP367"

CP819

CP819: "CP819"

CP850

CP850: "CP850"

CP862

CP862: "CP862"

CP866

CP866: "CP866"

CP874

CP874: "CP874"

CP932

CP932: "CP932"

CP936

CP936: "CP936"

CP949

CP949: "CP949"

CP950

CP950: "CP950"

CSASCII

CSASCII: "CSASCII"

CSBIG5

CSBIG5: "CSBIG5"

CSEUCKR

CSEUCKR: "CSEUCKR"

CSEUCPKDFMTJAPANESE

CSEUCPKDFMTJAPANESE: "CSEUCPKDFMTJAPANESE"

CSEUCTW

CSEUCTW: "CSEUCTW"

CSGB2312

CSGB2312: "CSGB2312"

CSHALFWIDTHKATAKANA

CSHALFWIDTHKATAKANA: "CSHALFWIDTHKATAKANA"

CSHPROMAN8

CSHPROMAN8: "CSHPROMAN8"

CSIBM866

CSIBM866: "CSIBM866"

CSISO14JISC6220RO

CSISO14JISC6220RO: "CSISO14JISC6220RO"

CSISO159JISX02121990

CSISO159JISX02121990: "CSISO159JISX02121990"

CSISO2022CN

CSISO2022CN: "CSISO2022CN"

CSISO2022JP

CSISO2022JP: "CSISO2022JP"

CSISO2022JP2

CSISO2022JP2: "CSISO2022JP2"

CSISO2022KR

CSISO2022KR: "CSISO2022KR"

CSISO57GB1988

CSISO57GB1988: "CSISO57GB1988"

CSISO58GB231280

CSISO58GB231280: "CSISO58GB231280"

CSISO87JISX0208

CSISO87JISX0208: "CSISO87JISX0208"

CSISOLATIN1

CSISOLATIN1: "CSISOLATIN1"

CSISOLATIN2

CSISOLATIN2: "CSISOLATIN2"

CSISOLATIN3

CSISOLATIN3: "CSISOLATIN3"

CSISOLATIN4

CSISOLATIN4: "CSISOLATIN4"

CSISOLATIN5

CSISOLATIN5: "CSISOLATIN5"

CSISOLATIN6

CSISOLATIN6: "CSISOLATIN6"

CSISOLATINARABIC

CSISOLATINARABIC: "CSISOLATINARABIC"

CSISOLATINCYRILLIC

CSISOLATINCYRILLIC: "CSISOLATINCYRILLIC"

CSISOLATINGREEK

CSISOLATINGREEK: "CSISOLATINGREEK"

CSISOLATINHEBREW

CSISOLATINHEBREW: "CSISOLATINHEBREW"

CSKOI8R

CSKOI8R: "CSKOI8R"

CSKSC56011987

CSKSC56011987: "CSKSC56011987"

CSKZ1048

CSKZ1048: "CSKZ1048"

CSMACINTOSH

CSMACINTOSH: "CSMACINTOSH"

CSPC850MULTILINGUAL

CSPC850MULTILINGUAL: "CSPC850MULTILINGUAL"

CSPC862LATINHEBREW

CSPC862LATINHEBREW: "CSPC862LATINHEBREW"

CSPTCP154

CSPTCP154: "CSPTCP154"

CSSHIFTJIS

CSSHIFTJIS: "CSSHIFTJIS"

CSUCS4

CSUCS4: "CSUCS4"

CSUNICODE

CSUNICODE: "CSUNICODE"

CSUNICODE11

CSUNICODE11: "CSUNICODE11"

CSUNICODE11UTF7

CSUNICODE11UTF7: "CSUNICODE11UTF7"

CSVISCII

CSVISCII: "CSVISCII"

CYRILLIC

CYRILLIC: "CYRILLIC"

CYRILLIC_ASIAN

CYRILLIC_ASIAN: "CYRILLIC-ASIAN"

ECMA_114

ECMA_114: "ECMA-114"

ECMA_118

ECMA_118: "ECMA-118"

ELOT_928

ELOT_928: "ELOT_928"

EUCCN

EUCCN: "EUCCN"

EUCJP

EUCJP: "EUCJP"

EUCKR

EUCKR: "EUCKR"

EUCTW

EUCTW: "EUCTW"

EUC_CN

EUC_CN: "EUC-CN"

EUC_JP

EUC_JP: "EUC-JP"

EUC_KR

EUC_KR: "EUC-KR"

EUC_TW

EUC_TW: "EUC-TW"

EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE

EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE: "EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE"

GB18030

GB18030: "GB18030"

GB2312

GB2312: "GB2312"

GBK

GBK: "GBK"

GB_1988_80

GB_1988_80: "GB_1988-80"

GB_2312_80

GB_2312_80: "GB_2312-80"

GEORGIAN_ACADEMY

GEORGIAN_ACADEMY: "GEORGIAN-ACADEMY"

GEORGIAN_PS

GEORGIAN_PS: "GEORGIAN-PS"

GREEK

GREEK: "GREEK"

GREEK8

GREEK8: "GREEK8"

HEBREW

HEBREW: "HEBREW"

HP_ROMAN8

HP_ROMAN8: "HP-ROMAN8"

HZ

HZ: "HZ"

HZ_GB_2312

HZ_GB_2312: "HZ-GB-2312"

IBM367

IBM367: "IBM367"

IBM819

IBM819: "IBM819"

IBM850

IBM850: "IBM850"

IBM862

IBM862: "IBM862"

IBM866

IBM866: "IBM866"

IBM_CP1133

IBM_CP1133: "IBM-CP1133"

ISO646_CN

ISO646_CN: "ISO646-CN"

ISO646_JP

ISO646_JP: "ISO646-JP"

ISO646_US

ISO646_US: "ISO646-US"

ISO8859_1

ISO8859_1: "ISO8859-1"

ISO8859_10

ISO8859_10: "ISO8859-10"

ISO8859_11

ISO8859_11: "ISO8859-11"

ISO8859_13

ISO8859_13: "ISO8859-13"

ISO8859_14

ISO8859_14: "ISO8859-14"

ISO8859_15

ISO8859_15: "ISO8859-15"

ISO8859_16

ISO8859_16: "ISO8859-16"

ISO8859_2

ISO8859_2: "ISO8859-2"

ISO8859_3

ISO8859_3: "ISO8859-3"

ISO8859_4

ISO8859_4: "ISO8859-4"

ISO8859_5

ISO8859_5: "ISO8859-5"

ISO8859_6

ISO8859_6: "ISO8859-6"

ISO8859_7

ISO8859_7: "ISO8859-7"

ISO8859_8

ISO8859_8: "ISO8859-8"

ISO8859_9

ISO8859_9: "ISO8859-9"

ISO_10646_UCS_2

ISO_10646_UCS_2: "ISO-10646-UCS-2"

ISO_10646_UCS_4

ISO_10646_UCS_4: "ISO-10646-UCS-4"

ISO_2022_CN

ISO_2022_CN: "ISO-2022-CN"

ISO_2022_CN_EXT

ISO_2022_CN_EXT: "ISO-2022-CN-EXT"

ISO_2022_JP

ISO_2022_JP: "ISO-2022-JP"

ISO_2022_JP_1

ISO_2022_JP_1: "ISO-2022-JP-1"

ISO_2022_JP_2

ISO_2022_JP_2: "ISO-2022-JP-2"

ISO_2022_KR

ISO_2022_KR: "ISO-2022-KR"

ISO_646_IRV_1991

ISO_646_IRV_1991: "ISO_646.IRV:1991"

ISO_8859_1

ISO_8859_1: "ISO-8859-1"

ISO_8859_10

ISO_8859_10: "ISO-8859-10"

ISO_8859_10_1992

ISO_8859_10_1992: "ISO_8859-10:1992"

ISO_8859_11

ISO_8859_11: "ISO-8859-11"

ISO_8859_13

ISO_8859_13: "ISO-8859-13"

ISO_8859_14

ISO_8859_14: "ISO-8859-14"

ISO_8859_14_1998

ISO_8859_14_1998: "ISO_8859-14:1998"

ISO_8859_15

ISO_8859_15: "ISO-8859-15"

ISO_8859_15_1998

ISO_8859_15_1998: "ISO_8859-15:1998"

ISO_8859_16

ISO_8859_16: "ISO-8859-16"

ISO_8859_16_2001

ISO_8859_16_2001: "ISO_8859-16:2001"

ISO_8859_1_1987

ISO_8859_1_1987: "ISO_8859-1:1987"

ISO_8859_2

ISO_8859_2: "ISO-8859-2"

ISO_8859_2_1987

ISO_8859_2_1987: "ISO_8859-2:1987"

ISO_8859_3

ISO_8859_3: "ISO-8859-3"

ISO_8859_3_1988

ISO_8859_3_1988: "ISO_8859-3:1988"

ISO_8859_4

ISO_8859_4: "ISO-8859-4"

ISO_8859_4_1988

ISO_8859_4_1988: "ISO_8859-4:1988"

ISO_8859_5

ISO_8859_5: "ISO-8859-5"

ISO_8859_5_1988

ISO_8859_5_1988: "ISO_8859-5:1988"

ISO_8859_6

ISO_8859_6: "ISO-8859-6"

ISO_8859_6_1987

ISO_8859_6_1987: "ISO_8859-6:1987"

ISO_8859_7

ISO_8859_7: "ISO-8859-7"

ISO_8859_7_1987

ISO_8859_7_1987: "ISO_8859-7:1987"

ISO_8859_7_2003

ISO_8859_7_2003: "ISO_8859-7:2003"

ISO_8859_8

ISO_8859_8: "ISO-8859-8"

ISO_8859_8_1988

ISO_8859_8_1988: "ISO_8859-8:1988"

ISO_8859_9

ISO_8859_9: "ISO-8859-9"

ISO_8859_9_1989

ISO_8859_9_1989: "ISO_8859-9:1989"

ISO_CELTIC

ISO_CELTIC: "ISO-CELTIC"

ISO_IR_100

ISO_IR_100: "ISO-IR-100"

ISO_IR_101

ISO_IR_101: "ISO-IR-101"

ISO_IR_109

ISO_IR_109: "ISO-IR-109"

ISO_IR_110

ISO_IR_110: "ISO-IR-110"

ISO_IR_126

ISO_IR_126: "ISO-IR-126"

ISO_IR_127

ISO_IR_127: "ISO-IR-127"

ISO_IR_138

ISO_IR_138: "ISO-IR-138"

ISO_IR_14

ISO_IR_14: "ISO-IR-14"

ISO_IR_144

ISO_IR_144: "ISO-IR-144"

ISO_IR_148

ISO_IR_148: "ISO-IR-148"

ISO_IR_149

ISO_IR_149: "ISO-IR-149"

ISO_IR_157

ISO_IR_157: "ISO-IR-157"

ISO_IR_159

ISO_IR_159: "ISO-IR-159"

ISO_IR_165

ISO_IR_165: "ISO-IR-165"

ISO_IR_166

ISO_IR_166: "ISO-IR-166"

ISO_IR_179

ISO_IR_179: "ISO-IR-179"

ISO_IR_199

ISO_IR_199: "ISO-IR-199"

ISO_IR_203

ISO_IR_203: "ISO-IR-203"

ISO_IR_226

ISO_IR_226: "ISO-IR-226"

ISO_IR_57

ISO_IR_57: "ISO-IR-57"

ISO_IR_58

ISO_IR_58: "ISO-IR-58"

ISO_IR_6

ISO_IR_6: "ISO-IR-6"

ISO_IR_87

ISO_IR_87: "ISO-IR-87"

JAVA

JAVA: "JAVA"

JIS0208

JIS0208: "JIS0208"

JISX0201_1976

JISX0201_1976: "JISX0201-1976"

JIS_C6220_1969_RO

JIS_C6220_1969_RO: "JIS_C6220-1969-RO"

JIS_C6226_1983

JIS_C6226_1983: "JIS_C6226-1983"

JIS_X0201

JIS_X0201: "JIS_X0201"

JIS_X0208

JIS_X0208: "JIS_X0208"

JIS_X0208_1983

JIS_X0208_1983: "JIS_X0208-1983"

JIS_X0208_1990

JIS_X0208_1990: "JIS_X0208-1990"

JIS_X0212

JIS_X0212: "JIS_X0212"

JIS_X0212_1990

JIS_X0212_1990: "JIS_X0212-1990"

JIS_X0212_1990_0

JIS_X0212_1990_0: "JIS_X0212.1990-0"

JOHAB

JOHAB: "JOHAB"

JP

JP: "JP"

KOI8_R

KOI8_R: "KOI8-R"

KOI8_RU

KOI8_RU: "KOI8-RU"

KOI8_T

KOI8_T: "KOI8-T"

KOI8_U

KOI8_U: "KOI8-U"

KOREAN

KOREAN: "KOREAN"

KSC_5601

KSC_5601: "KSC_5601"

KS_C_5601_1987

KS_C_5601_1987: "KS_C_5601-1987"

KS_C_5601_1989

KS_C_5601_1989: "KS_C_5601-1989"

KZ_1048

KZ_1048: "KZ-1048"

L1

L1: "L1"

L10

L10: "L10"

L2

L2: "L2"

L3

L3: "L3"

L4

L4: "L4"

L5

L5: "L5"

L6

L6: "L6"

L7

L7: "L7"

L8

L8: "L8"

LATIN1

LATIN1: "LATIN1"

LATIN10

LATIN10: "LATIN10"

LATIN2

LATIN2: "LATIN2"

LATIN3

LATIN3: "LATIN3"

LATIN4

LATIN4: "LATIN4"

LATIN5

LATIN5: "LATIN5"

LATIN6

LATIN6: "LATIN6"

LATIN7

LATIN7: "LATIN7"

LATIN8

LATIN8: "LATIN8"

LATIN_9

LATIN_9: "LATIN-9"

MAC

MAC: "MAC"

MACARABIC

MACARABIC: "MACARABIC"

MACCENTRALEUROPE

MACCENTRALEUROPE: "MACCENTRALEUROPE"

MACCROATIAN

MACCROATIAN: "MACCROATIAN"

MACCYRILLIC

MACCYRILLIC: "MACCYRILLIC"

MACGREEK

MACGREEK: "MACGREEK"

MACHEBREW

MACHEBREW: "MACHEBREW"

MACICELAND

MACICELAND: "MACICELAND"

MACINTOSH

MACINTOSH: "MACINTOSH"

MACROMAN

MACROMAN: "MACROMAN"

MACROMANIA

MACROMANIA: "MACROMANIA"

MACTHAI

MACTHAI: "MACTHAI"

MACTURKISH

MACTURKISH: "MACTURKISH"

MACUKRAINE

MACUKRAINE: "MACUKRAINE"

MS936

MS936: "MS936"

MS_ANSI

MS_ANSI: "MS-ANSI"

MS_ARAB

MS_ARAB: "MS-ARAB"

MS_CYRL

MS_CYRL: "MS-CYRL"

MS_EE

MS_EE: "MS-EE"

MS_GREEK

MS_GREEK: "MS-GREEK"

MS_HEBR

MS_HEBR: "MS-HEBR"

MS_KANJI

MS_KANJI: "MS_KANJI"

MS_TURK

MS_TURK: "MS-TURK"

MULELAO_1

MULELAO_1: "MULELAO-1"

NEXTSTEP

NEXTSTEP: "NEXTSTEP"

PT154

PT154: "PT154"

PTCP154

PTCP154: "PTCP154"

R8

R8: "R8"

RK1048

RK1048: "RK1048"

ROMAN8

ROMAN8: "ROMAN8"

SHIFT_JIS

SHIFT_JIS: "SHIFT-JIS"

SJIS

SJIS: "SJIS"

STRK1048_2002

STRK1048_2002: "STRK1048-2002"

TCVN

TCVN: "TCVN"

TCVN5712_1

TCVN5712_1: "TCVN5712-1"

TCVN5712_1_1993

TCVN5712_1_1993: "TCVN5712-1:1993"

TCVN_5712

TCVN_5712: "TCVN-5712"

TIS620

TIS620: "TIS620"

TIS620_0

TIS620_0: "TIS620-0"

TIS620_2529_1

TIS620_2529_1: "TIS620.2529-1"

TIS620_2533_0

TIS620_2533_0: "TIS620.2533-0"

TIS620_2533_1

TIS620_2533_1: "TIS620.2533-1"

TIS_620

TIS_620: "TIS-620"

UCS_2

UCS_2: "UCS-2"

UCS_2BE

UCS_2BE: "UCS-2BE"

UCS_2LE

UCS_2LE: "UCS-2LE"

UCS_2_INTERNAL

UCS_2_INTERNAL: "UCS-2-INTERNAL"

UCS_2_SWAPPED

UCS_2_SWAPPED: "UCS-2-SWAPPED"

UCS_4

UCS_4: "UCS-4"

UCS_4BE

UCS_4BE: "UCS-4BE"

UCS_4LE

UCS_4LE: "UCS-4LE"

UCS_4_INTERNAL

UCS_4_INTERNAL: "UCS-4-INTERNAL"

UCS_4_SWAPPED

UCS_4_SWAPPED: "UCS-4-SWAPPED"

UHC

UHC: "UHC"

UNICODEBIG

UNICODEBIG: "UNICODEBIG"

UNICODELITTLE

UNICODELITTLE: "UNICODELITTLE"

UNICODE_1_1

UNICODE_1_1: "UNICODE-1-1"

UNICODE_1_1_UTF_7

UNICODE_1_1_UTF_7: "UNICODE-1-1-UTF-7"

US

US: "US"

US_ASCII

US_ASCII: "US-ASCII"

UTF_16

UTF_16: "UTF-16"

UTF_16BE

UTF_16BE: "UTF-16BE"

UTF_16LE

UTF_16LE: "UTF-16LE"

UTF_32

UTF_32: "UTF-32"

UTF_32BE

UTF_32BE: "UTF-32BE"

UTF_32LE

UTF_32LE: "UTF-32LE"

UTF_7

UTF_7: "UTF-7"

UTF_8

UTF_8: "UTF-8"

VISCII

VISCII: "VISCII"

VISCII1_1_1

VISCII1_1_1: "VISCII1.1-1"

WCHAR_T

WCHAR_T: "WCHAR_T"

WINBALTRIM

WINBALTRIM: "WINBALTRIM"

WINDOWS_1250

WINDOWS_1250: "WINDOWS-1250"

WINDOWS_1251

WINDOWS_1251: "WINDOWS-1251"

WINDOWS_1252

WINDOWS_1252: "WINDOWS-1252"

WINDOWS_1253

WINDOWS_1253: "WINDOWS-1253"

WINDOWS_1254

WINDOWS_1254: "WINDOWS-1254"

WINDOWS_1255

WINDOWS_1255: "WINDOWS-1255"

WINDOWS_1256

WINDOWS_1256: "WINDOWS-1256"

WINDOWS_1257

WINDOWS_1257: "WINDOWS-1257"

WINDOWS_1258

WINDOWS_1258: "WINDOWS-1258"

WINDOWS_874

WINDOWS_874: "WINDOWS-874"

WINDOWS_936

WINDOWS_936: "WINDOWS-936"

X0201

X0201: "X0201"

X0208

X0208: "X0208"

X0212

X0212: "X0212"

Settings

Member Visibility

Theme

On This Page

ANSI_X3_4_1968ANSI_X3_4_1986ARABICARMSCII_8ASCIIASMO_708BIG5BIG5HKSCSBIG5_HKSCSBIG5_HKSCS_1999BIG5_HKSCS_2001BIG5_HKSCS_2004BIG5_HKSCS_2008BIGFIVEBIG_5BIG_FIVEC99CHARCHINESECNCN_BIG5CN_GBCN_GB_ISOIR165CP1131CP1133CP1250CP1251CP1252CP1253CP1254CP1255CP1256CP1257CP1258CP1361CP154CP367CP819CP850CP862CP866CP874CP932CP936CP949CP950CSASCIICSBIG5CSEUCKRCSEUCPKDFMTJAPANESECSEUCTWCSGB2312CSHALFWIDTHKATAKANACSHPROMAN8CSIBM866CSISO14JISC6220ROCSISO159JISX02121990CSISO2022CNCSISO2022JPCSISO2022JP2CSISO2022KRCSISO57GB1988CSISO58GB231280CSISO87JISX0208CSISOLATIN1CSISOLATIN2CSISOLATIN3CSISOLATIN4CSISOLATIN5CSISOLATIN6CSISOLATINARABICCSISOLATINCYRILLICCSISOLATINGREEKCSISOLATINHEBREWCSKOI8RCSKSC56011987CSKZ1048CSMACINTOSHCSPC850MULTILINGUALCSPC862LATINHEBREWCSPTCP154CSSHIFTJISCSUCS4CSUNICODECSUNICODE11CSUNICODE11UTF7CSVISCIICYRILLICCYRILLIC_ASIANECMA_114ECMA_118ELOT_928EUCCNEUCJPEUCKREUCTWEUC_CNEUC_JPEUC_KREUC_TWEXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESEGB18030GB2312GBKGB_1988_80GB_2312_80GEORGIAN_ACADEMYGEORGIAN_PSGREEKGREEK8HEBREWHP_ROMAN8HZHZ_GB_2312IBM367IBM819IBM850IBM862IBM866IBM_CP1133ISO646_CNISO646_JPISO646_USISO8859_1ISO8859_10ISO8859_11ISO8859_13ISO8859_14ISO8859_15ISO8859_16ISO8859_2ISO8859_3ISO8859_4ISO8859_5ISO8859_6ISO8859_7ISO8859_8ISO8859_9ISO_10646_UCS_2ISO_10646_UCS_4ISO_2022_CNISO_2022_CN_EXTISO_2022_JPISO_2022_JP_1ISO_2022_JP_2ISO_2022_KRISO_646_IRV_1991ISO_8859_1ISO_8859_10ISO_8859_10_1992ISO_8859_11ISO_8859_13ISO_8859_14ISO_8859_14_1998ISO_8859_15ISO_8859_15_1998ISO_8859_16ISO_8859_16_2001ISO_8859_1_1987ISO_8859_2ISO_8859_2_1987ISO_8859_3ISO_8859_3_1988ISO_8859_4ISO_8859_4_1988ISO_8859_5ISO_8859_5_1988ISO_8859_6ISO_8859_6_1987ISO_8859_7ISO_8859_7_1987ISO_8859_7_2003ISO_8859_8ISO_8859_8_1988ISO_8859_9ISO_8859_9_1989ISO_CELTICISO_IR_100ISO_IR_101ISO_IR_109ISO_IR_110ISO_IR_126ISO_IR_127ISO_IR_138ISO_IR_14ISO_IR_144ISO_IR_148ISO_IR_149ISO_IR_157ISO_IR_159ISO_IR_165ISO_IR_166ISO_IR_179ISO_IR_199ISO_IR_203ISO_IR_226ISO_IR_57ISO_IR_58ISO_IR_6ISO_IR_87JAVAJIS0208JISX0201_1976JIS_C6220_1969_ROJIS_C6226_1983JIS_X0201JIS_X0208JIS_X0208_1983JIS_X0208_1990JIS_X0212JIS_X0212_1990JIS_X0212_1990_0JOHABJPKOI8_RKOI8_RUKOI8_TKOI8_UKOREANKSC_5601KS_C_5601_1987KS_C_5601_1989KZ_1048L1L10L2L3L4L5L6L7L8LATIN1LATIN10LATIN2LATIN3LATIN4LATIN5LATIN6LATIN7LATIN8LATIN_9MACMACARABICMACCENTRALEUROPEMACCROATIANMACCYRILLICMACGREEKMACHEBREWMACICELANDMACINTOSHMACROMANMACROMANIAMACTHAIMACTURKISHMACUKRAINEMS936MS_ANSIMS_ARABMS_CYRLMS_EEMS_GREEKMS_HEBRMS_KANJIMS_TURKMULELAO_1NEXTSTEPPT154PTCP154R8RK1048ROMAN8SHIFT_JISSJISSTRK1048_2002TCVNTCVN5712_1TCVN5712_1_1993TCVN_5712TIS620TIS620_0TIS620_2529_1TIS620_2533_0TIS620_2533_1TIS_620UCS_2UCS_2BEUCS_2LEUCS_2_INTERNALUCS_2_SWAPPEDUCS_4UCS_4BEUCS_4LEUCS_4_INTERNALUCS_4_SWAPPEDUHCUNICODEBIGUNICODELITTLEUNICODE_1_1UNICODE_1_1_UTF_7USUS_ASCIIUTF_16UTF_16BEUTF_16LEUTF_32UTF_32BEUTF_32LEUTF_7UTF_8VISCIIVISCII1_1_1WCHAR_TWINBALTRIMWINDOWS_1250WINDOWS_1251WINDOWS_1252WINDOWS_1253WINDOWS_1254WINDOWS_1255WINDOWS_1256WINDOWS_1257WINDOWS_1258WINDOWS_874WINDOWS_936X0201X0208X0212
\ No newline at end of file +

Enumeration Members

ANSI_X3_4_1968

ANSI_X3_4_1968: "ANSI_X3.4-1968"

ANSI_X3_4_1986

ANSI_X3_4_1986: "ANSI_X3.4-1986"

ARABIC

ARABIC: "ARABIC"

ARMSCII_8

ARMSCII_8: "ARMSCII-8"

ASCII

ASCII: "ASCII"

ASMO_708

ASMO_708: "ASMO-708"

BIG5

BIG5: "BIG5"

BIG5HKSCS

BIG5HKSCS: "BIG5HKSCS"

BIG5_HKSCS

BIG5_HKSCS: "BIG5-HKSCS"

BIG5_HKSCS_1999

BIG5_HKSCS_1999: "BIG5-HKSCS:1999"

BIG5_HKSCS_2001

BIG5_HKSCS_2001: "BIG5-HKSCS:2001"

BIG5_HKSCS_2004

BIG5_HKSCS_2004: "BIG5-HKSCS:2004"

BIG5_HKSCS_2008

BIG5_HKSCS_2008: "BIG5-HKSCS:2008"

BIGFIVE

BIGFIVE: "BIGFIVE"

BIG_5

BIG_5: "BIG-5"

BIG_FIVE

BIG_FIVE: "BIG-FIVE"

C99

C99: "C99"

CHAR

CHAR: "CHAR"

CHINESE

CHINESE: "CHINESE"

CN

CN: "CN"

CN_BIG5

CN_BIG5: "CN-BIG5"

CN_GB

CN_GB: "CN-GB"

CN_GB_ISOIR165

CN_GB_ISOIR165: "CN-GB-ISOIR165"

CP1131

CP1131: "CP1131"

CP1133

CP1133: "CP1133"

CP1250

CP1250: "CP1250"

CP1251

CP1251: "CP1251"

CP1252

CP1252: "CP1252"

CP1253

CP1253: "CP1253"

CP1254

CP1254: "CP1254"

CP1255

CP1255: "CP1255"

CP1256

CP1256: "CP1256"

CP1257

CP1257: "CP1257"

CP1258

CP1258: "CP1258"

CP1361

CP1361: "CP1361"

CP154

CP154: "CP154"

CP367

CP367: "CP367"

CP819

CP819: "CP819"

CP850

CP850: "CP850"

CP862

CP862: "CP862"

CP866

CP866: "CP866"

CP874

CP874: "CP874"

CP932

CP932: "CP932"

CP936

CP936: "CP936"

CP949

CP949: "CP949"

CP950

CP950: "CP950"

CSASCII

CSASCII: "CSASCII"

CSBIG5

CSBIG5: "CSBIG5"

CSEUCKR

CSEUCKR: "CSEUCKR"

CSEUCPKDFMTJAPANESE

CSEUCPKDFMTJAPANESE: "CSEUCPKDFMTJAPANESE"

CSEUCTW

CSEUCTW: "CSEUCTW"

CSGB2312

CSGB2312: "CSGB2312"

CSHALFWIDTHKATAKANA

CSHALFWIDTHKATAKANA: "CSHALFWIDTHKATAKANA"

CSHPROMAN8

CSHPROMAN8: "CSHPROMAN8"

CSIBM866

CSIBM866: "CSIBM866"

CSISO14JISC6220RO

CSISO14JISC6220RO: "CSISO14JISC6220RO"

CSISO159JISX02121990

CSISO159JISX02121990: "CSISO159JISX02121990"

CSISO2022CN

CSISO2022CN: "CSISO2022CN"

CSISO2022JP

CSISO2022JP: "CSISO2022JP"

CSISO2022JP2

CSISO2022JP2: "CSISO2022JP2"

CSISO2022KR

CSISO2022KR: "CSISO2022KR"

CSISO57GB1988

CSISO57GB1988: "CSISO57GB1988"

CSISO58GB231280

CSISO58GB231280: "CSISO58GB231280"

CSISO87JISX0208

CSISO87JISX0208: "CSISO87JISX0208"

CSISOLATIN1

CSISOLATIN1: "CSISOLATIN1"

CSISOLATIN2

CSISOLATIN2: "CSISOLATIN2"

CSISOLATIN3

CSISOLATIN3: "CSISOLATIN3"

CSISOLATIN4

CSISOLATIN4: "CSISOLATIN4"

CSISOLATIN5

CSISOLATIN5: "CSISOLATIN5"

CSISOLATIN6

CSISOLATIN6: "CSISOLATIN6"

CSISOLATINARABIC

CSISOLATINARABIC: "CSISOLATINARABIC"

CSISOLATINCYRILLIC

CSISOLATINCYRILLIC: "CSISOLATINCYRILLIC"

CSISOLATINGREEK

CSISOLATINGREEK: "CSISOLATINGREEK"

CSISOLATINHEBREW

CSISOLATINHEBREW: "CSISOLATINHEBREW"

CSKOI8R

CSKOI8R: "CSKOI8R"

CSKSC56011987

CSKSC56011987: "CSKSC56011987"

CSKZ1048

CSKZ1048: "CSKZ1048"

CSMACINTOSH

CSMACINTOSH: "CSMACINTOSH"

CSPC850MULTILINGUAL

CSPC850MULTILINGUAL: "CSPC850MULTILINGUAL"

CSPC862LATINHEBREW

CSPC862LATINHEBREW: "CSPC862LATINHEBREW"

CSPTCP154

CSPTCP154: "CSPTCP154"

CSSHIFTJIS

CSSHIFTJIS: "CSSHIFTJIS"

CSUCS4

CSUCS4: "CSUCS4"

CSUNICODE

CSUNICODE: "CSUNICODE"

CSUNICODE11

CSUNICODE11: "CSUNICODE11"

CSUNICODE11UTF7

CSUNICODE11UTF7: "CSUNICODE11UTF7"

CSVISCII

CSVISCII: "CSVISCII"

CYRILLIC

CYRILLIC: "CYRILLIC"

CYRILLIC_ASIAN

CYRILLIC_ASIAN: "CYRILLIC-ASIAN"

ECMA_114

ECMA_114: "ECMA-114"

ECMA_118

ECMA_118: "ECMA-118"

ELOT_928

ELOT_928: "ELOT_928"

EUCCN

EUCCN: "EUCCN"

EUCJP

EUCJP: "EUCJP"

EUCKR

EUCKR: "EUCKR"

EUCTW

EUCTW: "EUCTW"

EUC_CN

EUC_CN: "EUC-CN"

EUC_JP

EUC_JP: "EUC-JP"

EUC_KR

EUC_KR: "EUC-KR"

EUC_TW

EUC_TW: "EUC-TW"

EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE

EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE: "EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE"

GB18030

GB18030: "GB18030"

GB2312

GB2312: "GB2312"

GBK

GBK: "GBK"

GB_1988_80

GB_1988_80: "GB_1988-80"

GB_2312_80

GB_2312_80: "GB_2312-80"

GEORGIAN_ACADEMY

GEORGIAN_ACADEMY: "GEORGIAN-ACADEMY"

GEORGIAN_PS

GEORGIAN_PS: "GEORGIAN-PS"

GREEK

GREEK: "GREEK"

GREEK8

GREEK8: "GREEK8"

HEBREW

HEBREW: "HEBREW"

HP_ROMAN8

HP_ROMAN8: "HP-ROMAN8"

HZ

HZ: "HZ"

HZ_GB_2312

HZ_GB_2312: "HZ-GB-2312"

IBM367

IBM367: "IBM367"

IBM819

IBM819: "IBM819"

IBM850

IBM850: "IBM850"

IBM862

IBM862: "IBM862"

IBM866

IBM866: "IBM866"

IBM_CP1133

IBM_CP1133: "IBM-CP1133"

ISO646_CN

ISO646_CN: "ISO646-CN"

ISO646_JP

ISO646_JP: "ISO646-JP"

ISO646_US

ISO646_US: "ISO646-US"

ISO8859_1

ISO8859_1: "ISO8859-1"

ISO8859_10

ISO8859_10: "ISO8859-10"

ISO8859_11

ISO8859_11: "ISO8859-11"

ISO8859_13

ISO8859_13: "ISO8859-13"

ISO8859_14

ISO8859_14: "ISO8859-14"

ISO8859_15

ISO8859_15: "ISO8859-15"

ISO8859_16

ISO8859_16: "ISO8859-16"

ISO8859_2

ISO8859_2: "ISO8859-2"

ISO8859_3

ISO8859_3: "ISO8859-3"

ISO8859_4

ISO8859_4: "ISO8859-4"

ISO8859_5

ISO8859_5: "ISO8859-5"

ISO8859_6

ISO8859_6: "ISO8859-6"

ISO8859_7

ISO8859_7: "ISO8859-7"

ISO8859_8

ISO8859_8: "ISO8859-8"

ISO8859_9

ISO8859_9: "ISO8859-9"

ISO_10646_UCS_2

ISO_10646_UCS_2: "ISO-10646-UCS-2"

ISO_10646_UCS_4

ISO_10646_UCS_4: "ISO-10646-UCS-4"

ISO_2022_CN

ISO_2022_CN: "ISO-2022-CN"

ISO_2022_CN_EXT

ISO_2022_CN_EXT: "ISO-2022-CN-EXT"

ISO_2022_JP

ISO_2022_JP: "ISO-2022-JP"

ISO_2022_JP_1

ISO_2022_JP_1: "ISO-2022-JP-1"

ISO_2022_JP_2

ISO_2022_JP_2: "ISO-2022-JP-2"

ISO_2022_KR

ISO_2022_KR: "ISO-2022-KR"

ISO_646_IRV_1991

ISO_646_IRV_1991: "ISO_646.IRV:1991"

ISO_8859_1

ISO_8859_1: "ISO-8859-1"

ISO_8859_10

ISO_8859_10: "ISO-8859-10"

ISO_8859_10_1992

ISO_8859_10_1992: "ISO_8859-10:1992"

ISO_8859_11

ISO_8859_11: "ISO-8859-11"

ISO_8859_13

ISO_8859_13: "ISO-8859-13"

ISO_8859_14

ISO_8859_14: "ISO-8859-14"

ISO_8859_14_1998

ISO_8859_14_1998: "ISO_8859-14:1998"

ISO_8859_15

ISO_8859_15: "ISO-8859-15"

ISO_8859_15_1998

ISO_8859_15_1998: "ISO_8859-15:1998"

ISO_8859_16

ISO_8859_16: "ISO-8859-16"

ISO_8859_16_2001

ISO_8859_16_2001: "ISO_8859-16:2001"

ISO_8859_1_1987

ISO_8859_1_1987: "ISO_8859-1:1987"

ISO_8859_2

ISO_8859_2: "ISO-8859-2"

ISO_8859_2_1987

ISO_8859_2_1987: "ISO_8859-2:1987"

ISO_8859_3

ISO_8859_3: "ISO-8859-3"

ISO_8859_3_1988

ISO_8859_3_1988: "ISO_8859-3:1988"

ISO_8859_4

ISO_8859_4: "ISO-8859-4"

ISO_8859_4_1988

ISO_8859_4_1988: "ISO_8859-4:1988"

ISO_8859_5

ISO_8859_5: "ISO-8859-5"

ISO_8859_5_1988

ISO_8859_5_1988: "ISO_8859-5:1988"

ISO_8859_6

ISO_8859_6: "ISO-8859-6"

ISO_8859_6_1987

ISO_8859_6_1987: "ISO_8859-6:1987"

ISO_8859_7

ISO_8859_7: "ISO-8859-7"

ISO_8859_7_1987

ISO_8859_7_1987: "ISO_8859-7:1987"

ISO_8859_7_2003

ISO_8859_7_2003: "ISO_8859-7:2003"

ISO_8859_8

ISO_8859_8: "ISO-8859-8"

ISO_8859_8_1988

ISO_8859_8_1988: "ISO_8859-8:1988"

ISO_8859_9

ISO_8859_9: "ISO-8859-9"

ISO_8859_9_1989

ISO_8859_9_1989: "ISO_8859-9:1989"

ISO_CELTIC

ISO_CELTIC: "ISO-CELTIC"

ISO_IR_100

ISO_IR_100: "ISO-IR-100"

ISO_IR_101

ISO_IR_101: "ISO-IR-101"

ISO_IR_109

ISO_IR_109: "ISO-IR-109"

ISO_IR_110

ISO_IR_110: "ISO-IR-110"

ISO_IR_126

ISO_IR_126: "ISO-IR-126"

ISO_IR_127

ISO_IR_127: "ISO-IR-127"

ISO_IR_138

ISO_IR_138: "ISO-IR-138"

ISO_IR_14

ISO_IR_14: "ISO-IR-14"

ISO_IR_144

ISO_IR_144: "ISO-IR-144"

ISO_IR_148

ISO_IR_148: "ISO-IR-148"

ISO_IR_149

ISO_IR_149: "ISO-IR-149"

ISO_IR_157

ISO_IR_157: "ISO-IR-157"

ISO_IR_159

ISO_IR_159: "ISO-IR-159"

ISO_IR_165

ISO_IR_165: "ISO-IR-165"

ISO_IR_166

ISO_IR_166: "ISO-IR-166"

ISO_IR_179

ISO_IR_179: "ISO-IR-179"

ISO_IR_199

ISO_IR_199: "ISO-IR-199"

ISO_IR_203

ISO_IR_203: "ISO-IR-203"

ISO_IR_226

ISO_IR_226: "ISO-IR-226"

ISO_IR_57

ISO_IR_57: "ISO-IR-57"

ISO_IR_58

ISO_IR_58: "ISO-IR-58"

ISO_IR_6

ISO_IR_6: "ISO-IR-6"

ISO_IR_87

ISO_IR_87: "ISO-IR-87"

JAVA

JAVA: "JAVA"

JIS0208

JIS0208: "JIS0208"

JISX0201_1976

JISX0201_1976: "JISX0201-1976"

JIS_C6220_1969_RO

JIS_C6220_1969_RO: "JIS_C6220-1969-RO"

JIS_C6226_1983

JIS_C6226_1983: "JIS_C6226-1983"

JIS_X0201

JIS_X0201: "JIS_X0201"

JIS_X0208

JIS_X0208: "JIS_X0208"

JIS_X0208_1983

JIS_X0208_1983: "JIS_X0208-1983"

JIS_X0208_1990

JIS_X0208_1990: "JIS_X0208-1990"

JIS_X0212

JIS_X0212: "JIS_X0212"

JIS_X0212_1990

JIS_X0212_1990: "JIS_X0212-1990"

JIS_X0212_1990_0

JIS_X0212_1990_0: "JIS_X0212.1990-0"

JOHAB

JOHAB: "JOHAB"

JP

JP: "JP"

KOI8_R

KOI8_R: "KOI8-R"

KOI8_RU

KOI8_RU: "KOI8-RU"

KOI8_T

KOI8_T: "KOI8-T"

KOI8_U

KOI8_U: "KOI8-U"

KOREAN

KOREAN: "KOREAN"

KSC_5601

KSC_5601: "KSC_5601"

KS_C_5601_1987

KS_C_5601_1987: "KS_C_5601-1987"

KS_C_5601_1989

KS_C_5601_1989: "KS_C_5601-1989"

KZ_1048

KZ_1048: "KZ-1048"

L1

L1: "L1"

L10

L10: "L10"

L2

L2: "L2"

L3

L3: "L3"

L4

L4: "L4"

L5

L5: "L5"

L6

L6: "L6"

L7

L7: "L7"

L8

L8: "L8"

LATIN1

LATIN1: "LATIN1"

LATIN10

LATIN10: "LATIN10"

LATIN2

LATIN2: "LATIN2"

LATIN3

LATIN3: "LATIN3"

LATIN4

LATIN4: "LATIN4"

LATIN5

LATIN5: "LATIN5"

LATIN6

LATIN6: "LATIN6"

LATIN7

LATIN7: "LATIN7"

LATIN8

LATIN8: "LATIN8"

LATIN_9

LATIN_9: "LATIN-9"

MAC

MAC: "MAC"

MACARABIC

MACARABIC: "MACARABIC"

MACCENTRALEUROPE

MACCENTRALEUROPE: "MACCENTRALEUROPE"

MACCROATIAN

MACCROATIAN: "MACCROATIAN"

MACCYRILLIC

MACCYRILLIC: "MACCYRILLIC"

MACGREEK

MACGREEK: "MACGREEK"

MACHEBREW

MACHEBREW: "MACHEBREW"

MACICELAND

MACICELAND: "MACICELAND"

MACINTOSH

MACINTOSH: "MACINTOSH"

MACROMAN

MACROMAN: "MACROMAN"

MACROMANIA

MACROMANIA: "MACROMANIA"

MACTHAI

MACTHAI: "MACTHAI"

MACTURKISH

MACTURKISH: "MACTURKISH"

MACUKRAINE

MACUKRAINE: "MACUKRAINE"

MS936

MS936: "MS936"

MS_ANSI

MS_ANSI: "MS-ANSI"

MS_ARAB

MS_ARAB: "MS-ARAB"

MS_CYRL

MS_CYRL: "MS-CYRL"

MS_EE

MS_EE: "MS-EE"

MS_GREEK

MS_GREEK: "MS-GREEK"

MS_HEBR

MS_HEBR: "MS-HEBR"

MS_KANJI

MS_KANJI: "MS_KANJI"

MS_TURK

MS_TURK: "MS-TURK"

MULELAO_1

MULELAO_1: "MULELAO-1"

NEXTSTEP

NEXTSTEP: "NEXTSTEP"

PT154

PT154: "PT154"

PTCP154

PTCP154: "PTCP154"

R8

R8: "R8"

RK1048

RK1048: "RK1048"

ROMAN8

ROMAN8: "ROMAN8"

SHIFT_JIS

SHIFT_JIS: "SHIFT-JIS"

SJIS

SJIS: "SJIS"

STRK1048_2002

STRK1048_2002: "STRK1048-2002"

TCVN

TCVN: "TCVN"

TCVN5712_1

TCVN5712_1: "TCVN5712-1"

TCVN5712_1_1993

TCVN5712_1_1993: "TCVN5712-1:1993"

TCVN_5712

TCVN_5712: "TCVN-5712"

TIS620

TIS620: "TIS620"

TIS620_0

TIS620_0: "TIS620-0"

TIS620_2529_1

TIS620_2529_1: "TIS620.2529-1"

TIS620_2533_0

TIS620_2533_0: "TIS620.2533-0"

TIS620_2533_1

TIS620_2533_1: "TIS620.2533-1"

TIS_620

TIS_620: "TIS-620"

UCS_2

UCS_2: "UCS-2"

UCS_2BE

UCS_2BE: "UCS-2BE"

UCS_2LE

UCS_2LE: "UCS-2LE"

UCS_2_INTERNAL

UCS_2_INTERNAL: "UCS-2-INTERNAL"

UCS_2_SWAPPED

UCS_2_SWAPPED: "UCS-2-SWAPPED"

UCS_4

UCS_4: "UCS-4"

UCS_4BE

UCS_4BE: "UCS-4BE"

UCS_4LE

UCS_4LE: "UCS-4LE"

UCS_4_INTERNAL

UCS_4_INTERNAL: "UCS-4-INTERNAL"

UCS_4_SWAPPED

UCS_4_SWAPPED: "UCS-4-SWAPPED"

UHC

UHC: "UHC"

UNICODEBIG

UNICODEBIG: "UNICODEBIG"

UNICODELITTLE

UNICODELITTLE: "UNICODELITTLE"

UNICODE_1_1

UNICODE_1_1: "UNICODE-1-1"

UNICODE_1_1_UTF_7

UNICODE_1_1_UTF_7: "UNICODE-1-1-UTF-7"

US

US: "US"

US_ASCII

US_ASCII: "US-ASCII"

UTF_16

UTF_16: "UTF-16"

UTF_16BE

UTF_16BE: "UTF-16BE"

UTF_16LE

UTF_16LE: "UTF-16LE"

UTF_32

UTF_32: "UTF-32"

UTF_32BE

UTF_32BE: "UTF-32BE"

UTF_32LE

UTF_32LE: "UTF-32LE"

UTF_7

UTF_7: "UTF-7"

UTF_8

UTF_8: "UTF-8"

VISCII

VISCII: "VISCII"

VISCII1_1_1

VISCII1_1_1: "VISCII1.1-1"

WCHAR_T

WCHAR_T: "WCHAR_T"

WINBALTRIM

WINBALTRIM: "WINBALTRIM"

WINDOWS_1250

WINDOWS_1250: "WINDOWS-1250"

WINDOWS_1251

WINDOWS_1251: "WINDOWS-1251"

WINDOWS_1252

WINDOWS_1252: "WINDOWS-1252"

WINDOWS_1253

WINDOWS_1253: "WINDOWS-1253"

WINDOWS_1254

WINDOWS_1254: "WINDOWS-1254"

WINDOWS_1255

WINDOWS_1255: "WINDOWS-1255"

WINDOWS_1256

WINDOWS_1256: "WINDOWS-1256"

WINDOWS_1257

WINDOWS_1257: "WINDOWS-1257"

WINDOWS_1258

WINDOWS_1258: "WINDOWS-1258"

WINDOWS_874

WINDOWS_874: "WINDOWS-874"

WINDOWS_936

WINDOWS_936: "WINDOWS-936"

X0201

X0201: "X0201"

X0208

X0208: "X0208"

X0212

X0212: "X0212"

Settings

Member Visibility

Theme

On This Page

ANSI_X3_4_1968ANSI_X3_4_1986ARABICARMSCII_8ASCIIASMO_708BIG5BIG5HKSCSBIG5_HKSCSBIG5_HKSCS_1999BIG5_HKSCS_2001BIG5_HKSCS_2004BIG5_HKSCS_2008BIGFIVEBIG_5BIG_FIVEC99CHARCHINESECNCN_BIG5CN_GBCN_GB_ISOIR165CP1131CP1133CP1250CP1251CP1252CP1253CP1254CP1255CP1256CP1257CP1258CP1361CP154CP367CP819CP850CP862CP866CP874CP932CP936CP949CP950CSASCIICSBIG5CSEUCKRCSEUCPKDFMTJAPANESECSEUCTWCSGB2312CSHALFWIDTHKATAKANACSHPROMAN8CSIBM866CSISO14JISC6220ROCSISO159JISX02121990CSISO2022CNCSISO2022JPCSISO2022JP2CSISO2022KRCSISO57GB1988CSISO58GB231280CSISO87JISX0208CSISOLATIN1CSISOLATIN2CSISOLATIN3CSISOLATIN4CSISOLATIN5CSISOLATIN6CSISOLATINARABICCSISOLATINCYRILLICCSISOLATINGREEKCSISOLATINHEBREWCSKOI8RCSKSC56011987CSKZ1048CSMACINTOSHCSPC850MULTILINGUALCSPC862LATINHEBREWCSPTCP154CSSHIFTJISCSUCS4CSUNICODECSUNICODE11CSUNICODE11UTF7CSVISCIICYRILLICCYRILLIC_ASIANECMA_114ECMA_118ELOT_928EUCCNEUCJPEUCKREUCTWEUC_CNEUC_JPEUC_KREUC_TWEXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESEGB18030GB2312GBKGB_1988_80GB_2312_80GEORGIAN_ACADEMYGEORGIAN_PSGREEKGREEK8HEBREWHP_ROMAN8HZHZ_GB_2312IBM367IBM819IBM850IBM862IBM866IBM_CP1133ISO646_CNISO646_JPISO646_USISO8859_1ISO8859_10ISO8859_11ISO8859_13ISO8859_14ISO8859_15ISO8859_16ISO8859_2ISO8859_3ISO8859_4ISO8859_5ISO8859_6ISO8859_7ISO8859_8ISO8859_9ISO_10646_UCS_2ISO_10646_UCS_4ISO_2022_CNISO_2022_CN_EXTISO_2022_JPISO_2022_JP_1ISO_2022_JP_2ISO_2022_KRISO_646_IRV_1991ISO_8859_1ISO_8859_10ISO_8859_10_1992ISO_8859_11ISO_8859_13ISO_8859_14ISO_8859_14_1998ISO_8859_15ISO_8859_15_1998ISO_8859_16ISO_8859_16_2001ISO_8859_1_1987ISO_8859_2ISO_8859_2_1987ISO_8859_3ISO_8859_3_1988ISO_8859_4ISO_8859_4_1988ISO_8859_5ISO_8859_5_1988ISO_8859_6ISO_8859_6_1987ISO_8859_7ISO_8859_7_1987ISO_8859_7_2003ISO_8859_8ISO_8859_8_1988ISO_8859_9ISO_8859_9_1989ISO_CELTICISO_IR_100ISO_IR_101ISO_IR_109ISO_IR_110ISO_IR_126ISO_IR_127ISO_IR_138ISO_IR_14ISO_IR_144ISO_IR_148ISO_IR_149ISO_IR_157ISO_IR_159ISO_IR_165ISO_IR_166ISO_IR_179ISO_IR_199ISO_IR_203ISO_IR_226ISO_IR_57ISO_IR_58ISO_IR_6ISO_IR_87JAVAJIS0208JISX0201_1976JIS_C6220_1969_ROJIS_C6226_1983JIS_X0201JIS_X0208JIS_X0208_1983JIS_X0208_1990JIS_X0212JIS_X0212_1990JIS_X0212_1990_0JOHABJPKOI8_RKOI8_RUKOI8_TKOI8_UKOREANKSC_5601KS_C_5601_1987KS_C_5601_1989KZ_1048L1L10L2L3L4L5L6L7L8LATIN1LATIN10LATIN2LATIN3LATIN4LATIN5LATIN6LATIN7LATIN8LATIN_9MACMACARABICMACCENTRALEUROPEMACCROATIANMACCYRILLICMACGREEKMACHEBREWMACICELANDMACINTOSHMACROMANMACROMANIAMACTHAIMACTURKISHMACUKRAINEMS936MS_ANSIMS_ARABMS_CYRLMS_EEMS_GREEKMS_HEBRMS_KANJIMS_TURKMULELAO_1NEXTSTEPPT154PTCP154R8RK1048ROMAN8SHIFT_JISSJISSTRK1048_2002TCVNTCVN5712_1TCVN5712_1_1993TCVN_5712TIS620TIS620_0TIS620_2529_1TIS620_2533_0TIS620_2533_1TIS_620UCS_2UCS_2BEUCS_2LEUCS_2_INTERNALUCS_2_SWAPPEDUCS_4UCS_4BEUCS_4LEUCS_4_INTERNALUCS_4_SWAPPEDUHCUNICODEBIGUNICODELITTLEUNICODE_1_1UNICODE_1_1_UTF_7USUS_ASCIIUTF_16UTF_16BEUTF_16LEUTF_32UTF_32BEUTF_32LEUTF_7UTF_8VISCIIVISCII1_1_1WCHAR_TWINBALTRIMWINDOWS_1250WINDOWS_1251WINDOWS_1252WINDOWS_1253WINDOWS_1254WINDOWS_1255WINDOWS_1256WINDOWS_1257WINDOWS_1258WINDOWS_874WINDOWS_936X0201X0208X0212
\ No newline at end of file diff --git a/docs/enums/Cea608ChannelType.html b/docs/enums/Cea608ChannelType.html index b8a0faa31..4892f797b 100644 --- a/docs/enums/Cea608ChannelType.html +++ b/docs/enums/Cea608ChannelType.html @@ -1,4 +1,4 @@ Cea608ChannelType | @bitmovin/api-sdk

Enumeration Cea608ChannelType

Subtitle channel track

-

Export

Enumeration Members

CC1 +

Export

Enumeration Members

CC1 CC3 -

Enumeration Members

CC1

CC1: "CC1"

CC3

CC3: "CC3"

Settings

Member Visibility

Theme

On This Page

CC1CC3
\ No newline at end of file +

Enumeration Members

CC1

CC1: "CC1"

CC3

CC3: "CC3"

Settings

Member Visibility

Theme

On This Page

CC1CC3
\ No newline at end of file diff --git a/docs/enums/ChannelLayout.html b/docs/enums/ChannelLayout.html index 0067e731d..8d5dbfb64 100644 --- a/docs/enums/ChannelLayout.html +++ b/docs/enums/ChannelLayout.html @@ -1,4 +1,4 @@ -ChannelLayout | @bitmovin/api-sdk

Enumeration ChannelLayout

Export

Enumeration Members

CL_STEREO +ChannelLayout | @bitmovin/api-sdk

Enumeration ChannelLayout

Export

Enumeration Members

CL_STEREO MONO NONE -

Enumeration Members

CL_STEREO

CL_STEREO: "STEREO"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_STEREOMONONONE
\ No newline at end of file +

Enumeration Members

CL_STEREO

CL_STEREO: "STEREO"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_STEREOMONONONE
\ No newline at end of file diff --git a/docs/enums/ChannelsAttributeForAudio.html b/docs/enums/ChannelsAttributeForAudio.html index d2b53b2b6..6e286ca5e 100644 --- a/docs/enums/ChannelsAttributeForAudio.html +++ b/docs/enums/ChannelsAttributeForAudio.html @@ -1,4 +1,4 @@ -ChannelsAttributeForAudio | @bitmovin/api-sdk

Enumeration ChannelsAttributeForAudio

Export

Enumeration Members

ALWAYS +ChannelsAttributeForAudio | @bitmovin/api-sdk

Enumeration ChannelsAttributeForAudio

Export

Enumeration Members

ALWAYS LEGACY STANDARD_CONFORM -

Enumeration Members

ALWAYS

ALWAYS: "ALWAYS"

LEGACY

LEGACY: "LEGACY"

STANDARD_CONFORM

STANDARD_CONFORM: "STANDARD_CONFORM"

Settings

Member Visibility

Theme

On This Page

ALWAYSLEGACYSTANDARD_CONFORM
\ No newline at end of file +

Enumeration Members

ALWAYS

ALWAYS: "ALWAYS"

LEGACY

LEGACY: "LEGACY"

STANDARD_CONFORM

STANDARD_CONFORM: "STANDARD_CONFORM"

Settings

Member Visibility

Theme

On This Page

ALWAYSLEGACYSTANDARD_CONFORM
\ No newline at end of file diff --git a/docs/enums/ChromaLocation.html b/docs/enums/ChromaLocation.html index 6e4745570..f9103fc0f 100644 --- a/docs/enums/ChromaLocation.html +++ b/docs/enums/ChromaLocation.html @@ -1,8 +1,8 @@ -ChromaLocation | @bitmovin/api-sdk

Enumeration ChromaLocation

Export

Enumeration Members

BOTTOM +ChromaLocation | @bitmovin/api-sdk

Enumeration ChromaLocation

Export

Enumeration Members

BOTTOM BOTTOMLEFT CENTER LEFT TOP TOPLEFT UNSPECIFIED -

Enumeration Members

BOTTOM

BOTTOM: "BOTTOM"

BOTTOMLEFT

BOTTOMLEFT: "BOTTOMLEFT"

CENTER

CENTER: "CENTER"

LEFT

LEFT: "LEFT"

TOP

TOP: "TOP"

TOPLEFT

TOPLEFT: "TOPLEFT"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

BOTTOMBOTTOMLEFTCENTERLEFTTOPTOPLEFTUNSPECIFIED
\ No newline at end of file +

Enumeration Members

BOTTOM

BOTTOM: "BOTTOM"

BOTTOMLEFT

BOTTOMLEFT: "BOTTOMLEFT"

CENTER

CENTER: "CENTER"

LEFT

LEFT: "LEFT"

TOP

TOP: "TOP"

TOPLEFT

TOPLEFT: "TOPLEFT"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

BOTTOMBOTTOMLEFTCENTERLEFTTOPTOPLEFTUNSPECIFIED
\ No newline at end of file diff --git a/docs/enums/CloudRegion.html b/docs/enums/CloudRegion.html index 55446003c..53d63f7ba 100644 --- a/docs/enums/CloudRegion.html +++ b/docs/enums/CloudRegion.html @@ -1,4 +1,4 @@ -CloudRegion | @bitmovin/api-sdk

Enumeration CloudRegion

Export

Enumeration Members

AFRICA +CloudRegion | @bitmovin/api-sdk

Enumeration CloudRegion

Export

Enumeration Members

AFRICA AKAMAI_BR_GRU AKAMAI_FR_PAR AKAMAI_JP_OSA @@ -72,4 +72,4 @@ OCI_EU_FRANKFURT_1 OCI_US_ASHBURN_1 SOUTH_AMERICA -

Enumeration Members

AFRICA

AFRICA: "AFRICA"

AKAMAI_BR_GRU

AKAMAI_BR_GRU: "AKAMAI_BR_GRU"

AKAMAI_FR_PAR

AKAMAI_FR_PAR: "AKAMAI_FR_PAR"

AKAMAI_JP_OSA

AKAMAI_JP_OSA: "AKAMAI_JP_OSA"

AKAMAI_US_SEA

AKAMAI_US_SEA: "AKAMAI_US_SEA"

ASIA

ASIA: "ASIA"

AUSTRALIA

AUSTRALIA: "AUSTRALIA"

AUTO

AUTO: "AUTO"

AWS

AWS: "AWS"

AWS_AP_NORTHEAST_1

AWS_AP_NORTHEAST_1: "AWS_AP_NORTHEAST_1"

AWS_AP_NORTHEAST_2

AWS_AP_NORTHEAST_2: "AWS_AP_NORTHEAST_2"

AWS_AP_SOUTHEAST_1

AWS_AP_SOUTHEAST_1: "AWS_AP_SOUTHEAST_1"

AWS_AP_SOUTHEAST_2

AWS_AP_SOUTHEAST_2: "AWS_AP_SOUTHEAST_2"

AWS_AP_SOUTH_1

AWS_AP_SOUTH_1: "AWS_AP_SOUTH_1"

AWS_CA_CENTRAL_1

AWS_CA_CENTRAL_1: "AWS_CA_CENTRAL_1"

AWS_EU_CENTRAL_1

AWS_EU_CENTRAL_1: "AWS_EU_CENTRAL_1"

AWS_EU_NORTH_1

AWS_EU_NORTH_1: "AWS_EU_NORTH_1"

AWS_EU_WEST_1

AWS_EU_WEST_1: "AWS_EU_WEST_1"

AWS_EU_WEST_2

AWS_EU_WEST_2: "AWS_EU_WEST_2"

AWS_EU_WEST_3

AWS_EU_WEST_3: "AWS_EU_WEST_3"

AWS_SA_EAST_1

AWS_SA_EAST_1: "AWS_SA_EAST_1"

AWS_US_EAST_1

AWS_US_EAST_1: "AWS_US_EAST_1"

AWS_US_EAST_2

AWS_US_EAST_2: "AWS_US_EAST_2"

AWS_US_WEST_1

AWS_US_WEST_1: "AWS_US_WEST_1"

AWS_US_WEST_2

AWS_US_WEST_2: "AWS_US_WEST_2"

AZURE_ASIA_EAST

AZURE_ASIA_EAST: "AZURE_ASIA_EAST"

AZURE_ASIA_SOUTHEAST

AZURE_ASIA_SOUTHEAST: "AZURE_ASIA_SOUTHEAST"

AZURE_AUSTRALIA_EAST

AZURE_AUSTRALIA_EAST: "AZURE_AUSTRALIA_EAST"

AZURE_AUSTRALIA_SOUTHEAST

AZURE_AUSTRALIA_SOUTHEAST: "AZURE_AUSTRALIA_SOUTHEAST"

AZURE_BRAZIL_SOUTH

AZURE_BRAZIL_SOUTH: "AZURE_BRAZIL_SOUTH"

AZURE_CANADA_CENTRAL

AZURE_CANADA_CENTRAL: "AZURE_CANADA_CENTRAL"

AZURE_EUROPE_NORTH

AZURE_EUROPE_NORTH: "AZURE_EUROPE_NORTH"

AZURE_EUROPE_WEST

AZURE_EUROPE_WEST: "AZURE_EUROPE_WEST"

AZURE_FRANCE_CENTRAL

AZURE_FRANCE_CENTRAL: "AZURE_FRANCE_CENTRAL"

AZURE_GERMANY_WESTCENTRAL

AZURE_GERMANY_WESTCENTRAL: "AZURE_GERMANY_WESTCENTRAL"

AZURE_INDIA_CENTRAL

AZURE_INDIA_CENTRAL: "AZURE_INDIA_CENTRAL"

AZURE_INDIA_SOUTH

AZURE_INDIA_SOUTH: "AZURE_INDIA_SOUTH"

AZURE_JAPAN_EAST

AZURE_JAPAN_EAST: "AZURE_JAPAN_EAST"

AZURE_JAPAN_WEST

AZURE_JAPAN_WEST: "AZURE_JAPAN_WEST"

AZURE_KOREA_CENTRAL

AZURE_KOREA_CENTRAL: "AZURE_KOREA_CENTRAL"

AZURE_UAE_NORTH

AZURE_UAE_NORTH: "AZURE_UAE_NORTH"

AZURE_UK_SOUTH

AZURE_UK_SOUTH: "AZURE_UK_SOUTH"

AZURE_US_CENTRAL

AZURE_US_CENTRAL: "AZURE_US_CENTRAL"

AZURE_US_EAST

AZURE_US_EAST: "AZURE_US_EAST"

AZURE_US_EAST2

AZURE_US_EAST2: "AZURE_US_EAST2"

AZURE_US_NORTH_CENTRAL

AZURE_US_NORTH_CENTRAL: "AZURE_US_NORTH_CENTRAL"

AZURE_US_SOUTH_CENTRAL

AZURE_US_SOUTH_CENTRAL: "AZURE_US_SOUTH_CENTRAL"

AZURE_US_WEST

AZURE_US_WEST: "AZURE_US_WEST"

AZURE_US_WEST2

AZURE_US_WEST2: "AZURE_US_WEST2"

EUROPE

EUROPE: "EUROPE"

EXTERNAL

EXTERNAL: "EXTERNAL"

GOOGLE

GOOGLE: "GOOGLE"

GOOGLE_ASIA_EAST_1

GOOGLE_ASIA_EAST_1: "GOOGLE_ASIA_EAST_1"

GOOGLE_ASIA_EAST_2

GOOGLE_ASIA_EAST_2: "GOOGLE_ASIA_EAST_2"

GOOGLE_ASIA_NORTHEAST_1

GOOGLE_ASIA_NORTHEAST_1: "GOOGLE_ASIA_NORTHEAST_1"

GOOGLE_ASIA_SOUTHEAST_1

GOOGLE_ASIA_SOUTHEAST_1: "GOOGLE_ASIA_SOUTHEAST_1"

GOOGLE_ASIA_SOUTH_1

GOOGLE_ASIA_SOUTH_1: "GOOGLE_ASIA_SOUTH_1"

GOOGLE_AUSTRALIA_SOUTHEAST_1

GOOGLE_AUSTRALIA_SOUTHEAST_1: "GOOGLE_AUSTRALIA_SOUTHEAST_1"

GOOGLE_EUROPE_NORTH_1

GOOGLE_EUROPE_NORTH_1: "GOOGLE_EUROPE_NORTH_1"

GOOGLE_EUROPE_WEST_1

GOOGLE_EUROPE_WEST_1: "GOOGLE_EUROPE_WEST_1"

GOOGLE_EUROPE_WEST_2

GOOGLE_EUROPE_WEST_2: "GOOGLE_EUROPE_WEST_2"

GOOGLE_EUROPE_WEST_3

GOOGLE_EUROPE_WEST_3: "GOOGLE_EUROPE_WEST_3"

GOOGLE_EUROPE_WEST_4

GOOGLE_EUROPE_WEST_4: "GOOGLE_EUROPE_WEST_4"

GOOGLE_NORTHAMERICA_NORTHEAST_1

GOOGLE_NORTHAMERICA_NORTHEAST_1: "GOOGLE_NORTHAMERICA_NORTHEAST_1"

GOOGLE_SOUTHAMERICA_EAST_1

GOOGLE_SOUTHAMERICA_EAST_1: "GOOGLE_SOUTHAMERICA_EAST_1"

GOOGLE_US_CENTRAL_1

GOOGLE_US_CENTRAL_1: "GOOGLE_US_CENTRAL_1"

GOOGLE_US_EAST_1

GOOGLE_US_EAST_1: "GOOGLE_US_EAST_1"

GOOGLE_US_EAST_4

GOOGLE_US_EAST_4: "GOOGLE_US_EAST_4"

GOOGLE_US_WEST_1

GOOGLE_US_WEST_1: "GOOGLE_US_WEST_1"

GOOGLE_US_WEST_2

GOOGLE_US_WEST_2: "GOOGLE_US_WEST_2"

NORTH_AMERICA

NORTH_AMERICA: "NORTH_AMERICA"

OCI_EU_FRANKFURT_1

OCI_EU_FRANKFURT_1: "OCI_EU_FRANKFURT_1"

OCI_US_ASHBURN_1

OCI_US_ASHBURN_1: "OCI_US_ASHBURN_1"

SOUTH_AMERICA

SOUTH_AMERICA: "SOUTH_AMERICA"

Settings

Member Visibility

Theme

On This Page

AFRICAAKAMAI_BR_GRUAKAMAI_FR_PARAKAMAI_JP_OSAAKAMAI_US_SEAASIAAUSTRALIAAUTOAWSAWS_AP_NORTHEAST_1AWS_AP_NORTHEAST_2AWS_AP_SOUTHEAST_1AWS_AP_SOUTHEAST_2AWS_AP_SOUTH_1AWS_CA_CENTRAL_1AWS_EU_CENTRAL_1AWS_EU_NORTH_1AWS_EU_WEST_1AWS_EU_WEST_2AWS_EU_WEST_3AWS_SA_EAST_1AWS_US_EAST_1AWS_US_EAST_2AWS_US_WEST_1AWS_US_WEST_2AZURE_ASIA_EASTAZURE_ASIA_SOUTHEASTAZURE_AUSTRALIA_EASTAZURE_AUSTRALIA_SOUTHEASTAZURE_BRAZIL_SOUTHAZURE_CANADA_CENTRALAZURE_EUROPE_NORTHAZURE_EUROPE_WESTAZURE_FRANCE_CENTRALAZURE_GERMANY_WESTCENTRALAZURE_INDIA_CENTRALAZURE_INDIA_SOUTHAZURE_JAPAN_EASTAZURE_JAPAN_WESTAZURE_KOREA_CENTRALAZURE_UAE_NORTHAZURE_UK_SOUTHAZURE_US_CENTRALAZURE_US_EASTAZURE_US_EAST2AZURE_US_NORTH_CENTRALAZURE_US_SOUTH_CENTRALAZURE_US_WESTAZURE_US_WEST2EUROPEEXTERNALGOOGLEGOOGLE_ASIA_EAST_1GOOGLE_ASIA_EAST_2GOOGLE_ASIA_NORTHEAST_1GOOGLE_ASIA_SOUTHEAST_1GOOGLE_ASIA_SOUTH_1GOOGLE_AUSTRALIA_SOUTHEAST_1GOOGLE_EUROPE_NORTH_1GOOGLE_EUROPE_WEST_1GOOGLE_EUROPE_WEST_2GOOGLE_EUROPE_WEST_3GOOGLE_EUROPE_WEST_4GOOGLE_NORTHAMERICA_NORTHEAST_1GOOGLE_SOUTHAMERICA_EAST_1GOOGLE_US_CENTRAL_1GOOGLE_US_EAST_1GOOGLE_US_EAST_4GOOGLE_US_WEST_1GOOGLE_US_WEST_2NORTH_AMERICAOCI_EU_FRANKFURT_1OCI_US_ASHBURN_1SOUTH_AMERICA
\ No newline at end of file +

Enumeration Members

AFRICA

AFRICA: "AFRICA"

AKAMAI_BR_GRU

AKAMAI_BR_GRU: "AKAMAI_BR_GRU"

AKAMAI_FR_PAR

AKAMAI_FR_PAR: "AKAMAI_FR_PAR"

AKAMAI_JP_OSA

AKAMAI_JP_OSA: "AKAMAI_JP_OSA"

AKAMAI_US_SEA

AKAMAI_US_SEA: "AKAMAI_US_SEA"

ASIA

ASIA: "ASIA"

AUSTRALIA

AUSTRALIA: "AUSTRALIA"

AUTO

AUTO: "AUTO"

AWS

AWS: "AWS"

AWS_AP_NORTHEAST_1

AWS_AP_NORTHEAST_1: "AWS_AP_NORTHEAST_1"

AWS_AP_NORTHEAST_2

AWS_AP_NORTHEAST_2: "AWS_AP_NORTHEAST_2"

AWS_AP_SOUTHEAST_1

AWS_AP_SOUTHEAST_1: "AWS_AP_SOUTHEAST_1"

AWS_AP_SOUTHEAST_2

AWS_AP_SOUTHEAST_2: "AWS_AP_SOUTHEAST_2"

AWS_AP_SOUTH_1

AWS_AP_SOUTH_1: "AWS_AP_SOUTH_1"

AWS_CA_CENTRAL_1

AWS_CA_CENTRAL_1: "AWS_CA_CENTRAL_1"

AWS_EU_CENTRAL_1

AWS_EU_CENTRAL_1: "AWS_EU_CENTRAL_1"

AWS_EU_NORTH_1

AWS_EU_NORTH_1: "AWS_EU_NORTH_1"

AWS_EU_WEST_1

AWS_EU_WEST_1: "AWS_EU_WEST_1"

AWS_EU_WEST_2

AWS_EU_WEST_2: "AWS_EU_WEST_2"

AWS_EU_WEST_3

AWS_EU_WEST_3: "AWS_EU_WEST_3"

AWS_SA_EAST_1

AWS_SA_EAST_1: "AWS_SA_EAST_1"

AWS_US_EAST_1

AWS_US_EAST_1: "AWS_US_EAST_1"

AWS_US_EAST_2

AWS_US_EAST_2: "AWS_US_EAST_2"

AWS_US_WEST_1

AWS_US_WEST_1: "AWS_US_WEST_1"

AWS_US_WEST_2

AWS_US_WEST_2: "AWS_US_WEST_2"

AZURE_ASIA_EAST

AZURE_ASIA_EAST: "AZURE_ASIA_EAST"

AZURE_ASIA_SOUTHEAST

AZURE_ASIA_SOUTHEAST: "AZURE_ASIA_SOUTHEAST"

AZURE_AUSTRALIA_EAST

AZURE_AUSTRALIA_EAST: "AZURE_AUSTRALIA_EAST"

AZURE_AUSTRALIA_SOUTHEAST

AZURE_AUSTRALIA_SOUTHEAST: "AZURE_AUSTRALIA_SOUTHEAST"

AZURE_BRAZIL_SOUTH

AZURE_BRAZIL_SOUTH: "AZURE_BRAZIL_SOUTH"

AZURE_CANADA_CENTRAL

AZURE_CANADA_CENTRAL: "AZURE_CANADA_CENTRAL"

AZURE_EUROPE_NORTH

AZURE_EUROPE_NORTH: "AZURE_EUROPE_NORTH"

AZURE_EUROPE_WEST

AZURE_EUROPE_WEST: "AZURE_EUROPE_WEST"

AZURE_FRANCE_CENTRAL

AZURE_FRANCE_CENTRAL: "AZURE_FRANCE_CENTRAL"

AZURE_GERMANY_WESTCENTRAL

AZURE_GERMANY_WESTCENTRAL: "AZURE_GERMANY_WESTCENTRAL"

AZURE_INDIA_CENTRAL

AZURE_INDIA_CENTRAL: "AZURE_INDIA_CENTRAL"

AZURE_INDIA_SOUTH

AZURE_INDIA_SOUTH: "AZURE_INDIA_SOUTH"

AZURE_JAPAN_EAST

AZURE_JAPAN_EAST: "AZURE_JAPAN_EAST"

AZURE_JAPAN_WEST

AZURE_JAPAN_WEST: "AZURE_JAPAN_WEST"

AZURE_KOREA_CENTRAL

AZURE_KOREA_CENTRAL: "AZURE_KOREA_CENTRAL"

AZURE_UAE_NORTH

AZURE_UAE_NORTH: "AZURE_UAE_NORTH"

AZURE_UK_SOUTH

AZURE_UK_SOUTH: "AZURE_UK_SOUTH"

AZURE_US_CENTRAL

AZURE_US_CENTRAL: "AZURE_US_CENTRAL"

AZURE_US_EAST

AZURE_US_EAST: "AZURE_US_EAST"

AZURE_US_EAST2

AZURE_US_EAST2: "AZURE_US_EAST2"

AZURE_US_NORTH_CENTRAL

AZURE_US_NORTH_CENTRAL: "AZURE_US_NORTH_CENTRAL"

AZURE_US_SOUTH_CENTRAL

AZURE_US_SOUTH_CENTRAL: "AZURE_US_SOUTH_CENTRAL"

AZURE_US_WEST

AZURE_US_WEST: "AZURE_US_WEST"

AZURE_US_WEST2

AZURE_US_WEST2: "AZURE_US_WEST2"

EUROPE

EUROPE: "EUROPE"

EXTERNAL

EXTERNAL: "EXTERNAL"

GOOGLE

GOOGLE: "GOOGLE"

GOOGLE_ASIA_EAST_1

GOOGLE_ASIA_EAST_1: "GOOGLE_ASIA_EAST_1"

GOOGLE_ASIA_EAST_2

GOOGLE_ASIA_EAST_2: "GOOGLE_ASIA_EAST_2"

GOOGLE_ASIA_NORTHEAST_1

GOOGLE_ASIA_NORTHEAST_1: "GOOGLE_ASIA_NORTHEAST_1"

GOOGLE_ASIA_SOUTHEAST_1

GOOGLE_ASIA_SOUTHEAST_1: "GOOGLE_ASIA_SOUTHEAST_1"

GOOGLE_ASIA_SOUTH_1

GOOGLE_ASIA_SOUTH_1: "GOOGLE_ASIA_SOUTH_1"

GOOGLE_AUSTRALIA_SOUTHEAST_1

GOOGLE_AUSTRALIA_SOUTHEAST_1: "GOOGLE_AUSTRALIA_SOUTHEAST_1"

GOOGLE_EUROPE_NORTH_1

GOOGLE_EUROPE_NORTH_1: "GOOGLE_EUROPE_NORTH_1"

GOOGLE_EUROPE_WEST_1

GOOGLE_EUROPE_WEST_1: "GOOGLE_EUROPE_WEST_1"

GOOGLE_EUROPE_WEST_2

GOOGLE_EUROPE_WEST_2: "GOOGLE_EUROPE_WEST_2"

GOOGLE_EUROPE_WEST_3

GOOGLE_EUROPE_WEST_3: "GOOGLE_EUROPE_WEST_3"

GOOGLE_EUROPE_WEST_4

GOOGLE_EUROPE_WEST_4: "GOOGLE_EUROPE_WEST_4"

GOOGLE_NORTHAMERICA_NORTHEAST_1

GOOGLE_NORTHAMERICA_NORTHEAST_1: "GOOGLE_NORTHAMERICA_NORTHEAST_1"

GOOGLE_SOUTHAMERICA_EAST_1

GOOGLE_SOUTHAMERICA_EAST_1: "GOOGLE_SOUTHAMERICA_EAST_1"

GOOGLE_US_CENTRAL_1

GOOGLE_US_CENTRAL_1: "GOOGLE_US_CENTRAL_1"

GOOGLE_US_EAST_1

GOOGLE_US_EAST_1: "GOOGLE_US_EAST_1"

GOOGLE_US_EAST_4

GOOGLE_US_EAST_4: "GOOGLE_US_EAST_4"

GOOGLE_US_WEST_1

GOOGLE_US_WEST_1: "GOOGLE_US_WEST_1"

GOOGLE_US_WEST_2

GOOGLE_US_WEST_2: "GOOGLE_US_WEST_2"

NORTH_AMERICA

NORTH_AMERICA: "NORTH_AMERICA"

OCI_EU_FRANKFURT_1

OCI_EU_FRANKFURT_1: "OCI_EU_FRANKFURT_1"

OCI_US_ASHBURN_1

OCI_US_ASHBURN_1: "OCI_US_ASHBURN_1"

SOUTH_AMERICA

SOUTH_AMERICA: "SOUTH_AMERICA"

Settings

Member Visibility

Theme

On This Page

AFRICAAKAMAI_BR_GRUAKAMAI_FR_PARAKAMAI_JP_OSAAKAMAI_US_SEAASIAAUSTRALIAAUTOAWSAWS_AP_NORTHEAST_1AWS_AP_NORTHEAST_2AWS_AP_SOUTHEAST_1AWS_AP_SOUTHEAST_2AWS_AP_SOUTH_1AWS_CA_CENTRAL_1AWS_EU_CENTRAL_1AWS_EU_NORTH_1AWS_EU_WEST_1AWS_EU_WEST_2AWS_EU_WEST_3AWS_SA_EAST_1AWS_US_EAST_1AWS_US_EAST_2AWS_US_WEST_1AWS_US_WEST_2AZURE_ASIA_EASTAZURE_ASIA_SOUTHEASTAZURE_AUSTRALIA_EASTAZURE_AUSTRALIA_SOUTHEASTAZURE_BRAZIL_SOUTHAZURE_CANADA_CENTRALAZURE_EUROPE_NORTHAZURE_EUROPE_WESTAZURE_FRANCE_CENTRALAZURE_GERMANY_WESTCENTRALAZURE_INDIA_CENTRALAZURE_INDIA_SOUTHAZURE_JAPAN_EASTAZURE_JAPAN_WESTAZURE_KOREA_CENTRALAZURE_UAE_NORTHAZURE_UK_SOUTHAZURE_US_CENTRALAZURE_US_EASTAZURE_US_EAST2AZURE_US_NORTH_CENTRALAZURE_US_SOUTH_CENTRALAZURE_US_WESTAZURE_US_WEST2EUROPEEXTERNALGOOGLEGOOGLE_ASIA_EAST_1GOOGLE_ASIA_EAST_2GOOGLE_ASIA_NORTHEAST_1GOOGLE_ASIA_SOUTHEAST_1GOOGLE_ASIA_SOUTH_1GOOGLE_AUSTRALIA_SOUTHEAST_1GOOGLE_EUROPE_NORTH_1GOOGLE_EUROPE_WEST_1GOOGLE_EUROPE_WEST_2GOOGLE_EUROPE_WEST_3GOOGLE_EUROPE_WEST_4GOOGLE_NORTHAMERICA_NORTHEAST_1GOOGLE_SOUTHAMERICA_EAST_1GOOGLE_US_CENTRAL_1GOOGLE_US_EAST_1GOOGLE_US_EAST_4GOOGLE_US_WEST_1GOOGLE_US_WEST_2NORTH_AMERICAOCI_EU_FRANKFURT_1OCI_US_ASHBURN_1SOUTH_AMERICA
\ No newline at end of file diff --git a/docs/enums/CodecConfigType.html b/docs/enums/CodecConfigType.html index e93f51708..f79596718 100644 --- a/docs/enums/CodecConfigType.html +++ b/docs/enums/CodecConfigType.html @@ -1,4 +1,4 @@ -CodecConfigType | @bitmovin/api-sdk

Enumeration CodecConfigType

Export

Enumeration Members

AAC +CodecConfigType | @bitmovin/api-sdk

Enumeration CodecConfigType

Export

Enumeration Members

AAC AC3 AUDIO_PASSTHROUGH AV1 @@ -25,4 +25,4 @@ VP8 VP9 WEBVTT -

Enumeration Members

AAC

AAC: "AAC"

AC3

AC3: "AC3"

AUDIO_PASSTHROUGH

AUDIO_PASSTHROUGH: "AUDIO_PASSTHROUGH"

AV1

AV1: "AV1"

DD

DD: "DD"

DDPLUS

DDPLUS: "DDPLUS"

DOLBY_ATMOS

DOLBY_ATMOS: "DOLBY_ATMOS"

DTS

DTS: "DTS"

DTSX

DTSX: "DTSX"

DTS_PASSTHROUGH

DTS_PASSTHROUGH: "DTS_PASSTHROUGH"

DVB_SUBTITLE

DVB_SUBTITLE: "DVB_SUBTITLE"

EAC3

EAC3: "EAC3"

H262

H262: "H262"

H264

H264: "H264"

H265

H265: "H265"

HE_AAC_V1

HE_AAC_V1: "HE_AAC_V1"

HE_AAC_V2

HE_AAC_V2: "HE_AAC_V2"

IMSC

IMSC: "IMSC"

MJPEG

MJPEG: "MJPEG"

MP2

MP2: "MP2"

MP3

MP3: "MP3"

OPUS

OPUS: "OPUS"

PCM

PCM: "PCM"

VORBIS

VORBIS: "VORBIS"

VP8

VP8: "VP8"

VP9

VP9: "VP9"

WEBVTT

WEBVTT: "WEBVTT"

Settings

Member Visibility

Theme

On This Page

AACAC3AUDIO_PASSTHROUGHAV1DDDDPLUSDOLBY_ATMOSDTSDTSXDTS_PASSTHROUGHDVB_SUBTITLEEAC3H262H264H265HE_AAC_V1HE_AAC_V2IMSCMJPEGMP2MP3OPUSPCMVORBISVP8VP9WEBVTT
\ No newline at end of file +

Enumeration Members

AAC

AAC: "AAC"

AC3

AC3: "AC3"

AUDIO_PASSTHROUGH

AUDIO_PASSTHROUGH: "AUDIO_PASSTHROUGH"

AV1

AV1: "AV1"

DD

DD: "DD"

DDPLUS

DDPLUS: "DDPLUS"

DOLBY_ATMOS

DOLBY_ATMOS: "DOLBY_ATMOS"

DTS

DTS: "DTS"

DTSX

DTSX: "DTSX"

DTS_PASSTHROUGH

DTS_PASSTHROUGH: "DTS_PASSTHROUGH"

DVB_SUBTITLE

DVB_SUBTITLE: "DVB_SUBTITLE"

EAC3

EAC3: "EAC3"

H262

H262: "H262"

H264

H264: "H264"

H265

H265: "H265"

HE_AAC_V1

HE_AAC_V1: "HE_AAC_V1"

HE_AAC_V2

HE_AAC_V2: "HE_AAC_V2"

IMSC

IMSC: "IMSC"

MJPEG

MJPEG: "MJPEG"

MP2

MP2: "MP2"

MP3

MP3: "MP3"

OPUS

OPUS: "OPUS"

PCM

PCM: "PCM"

VORBIS

VORBIS: "VORBIS"

VP8

VP8: "VP8"

VP9

VP9: "VP9"

WEBVTT

WEBVTT: "WEBVTT"

Settings

Member Visibility

Theme

On This Page

AACAC3AUDIO_PASSTHROUGHAV1DDDDPLUSDOLBY_ATMOSDTSDTSXDTS_PASSTHROUGHDVB_SUBTITLEEAC3H262H264H265HE_AAC_V1HE_AAC_V2IMSCMJPEGMP2MP3OPUSPCMVORBISVP8VP9WEBVTT
\ No newline at end of file diff --git a/docs/enums/ColorPrimaries.html b/docs/enums/ColorPrimaries.html index 9abe9432e..7a4688629 100644 --- a/docs/enums/ColorPrimaries.html +++ b/docs/enums/ColorPrimaries.html @@ -1,4 +1,4 @@ -ColorPrimaries | @bitmovin/api-sdk

Enumeration ColorPrimaries

Export

Enumeration Members

BT2020 +ColorPrimaries | @bitmovin/api-sdk

Enumeration ColorPrimaries

Export

Enumeration Members

BT2020 BT470BG BT470M BT709 @@ -11,4 +11,4 @@ SMPTE432 SMPTEST428_1 UNSPECIFIED -

Enumeration Members

BT2020

BT2020: "BT2020"

BT470BG

BT470BG: "BT470BG"

BT470M

BT470M: "BT470M"

BT709

BT709: "BT709"

FILM

FILM: "FILM"

JEDEC_P22

JEDEC_P22: "JEDEC_P22"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE240M

SMPTE240M: "SMPTE240M"

SMPTE428

SMPTE428: "SMPTE428"

SMPTE431

SMPTE431: "SMPTE431"

SMPTE432

SMPTE432: "SMPTE432"

SMPTEST428_1

SMPTEST428_1: "SMPTEST428_1"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

BT2020BT470BGBT470MBT709FILMJEDEC_P22SMPTE170MSMPTE240MSMPTE428SMPTE431SMPTE432SMPTEST428_1UNSPECIFIED
\ No newline at end of file +

Enumeration Members

BT2020

BT2020: "BT2020"

BT470BG

BT470BG: "BT470BG"

BT470M

BT470M: "BT470M"

BT709

BT709: "BT709"

FILM

FILM: "FILM"

JEDEC_P22

JEDEC_P22: "JEDEC_P22"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE240M

SMPTE240M: "SMPTE240M"

SMPTE428

SMPTE428: "SMPTE428"

SMPTE431

SMPTE431: "SMPTE431"

SMPTE432

SMPTE432: "SMPTE432"

SMPTEST428_1

SMPTEST428_1: "SMPTEST428_1"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

BT2020BT470BGBT470MBT709FILMJEDEC_P22SMPTE170MSMPTE240MSMPTE428SMPTE431SMPTE432SMPTEST428_1UNSPECIFIED
\ No newline at end of file diff --git a/docs/enums/ColorRange.html b/docs/enums/ColorRange.html index 23abce8c3..e641fee24 100644 --- a/docs/enums/ColorRange.html +++ b/docs/enums/ColorRange.html @@ -1,5 +1,5 @@ ColorRange | @bitmovin/api-sdk

Enumeration ColorRange

The color range to be applied

-

Export

Enumeration Members

JPEG +

Export

Enumeration Members

JPEG MPEG UNSPECIFIED -

Enumeration Members

JPEG

JPEG: "JPEG"

MPEG

MPEG: "MPEG"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

JPEGMPEGUNSPECIFIED
\ No newline at end of file +

Enumeration Members

JPEG

JPEG: "JPEG"

MPEG

MPEG: "MPEG"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

JPEGMPEGUNSPECIFIED
\ No newline at end of file diff --git a/docs/enums/ColorSpace.html b/docs/enums/ColorSpace.html index 3b0e5213e..93824c2bd 100644 --- a/docs/enums/ColorSpace.html +++ b/docs/enums/ColorSpace.html @@ -1,5 +1,5 @@ ColorSpace | @bitmovin/api-sdk

Enumeration ColorSpace

The color space to be applied

-

Export

Enumeration Members

BT2020_CL +

Export

Enumeration Members

BT2020_CL BT2020_NCL BT470BG BT709 @@ -11,4 +11,4 @@ UNSPECIFIED YCGCO YCOCG -

Enumeration Members

BT2020_CL

BT2020_CL: "BT2020_CL"

BT2020_NCL

BT2020_NCL: "BT2020_NCL"

BT470BG

BT470BG: "BT470BG"

BT709

BT709: "BT709"

FCC

FCC: "FCC"

RGB

RGB: "RGB"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE2085

SMPTE2085: "SMPTE2085"

SMPTE240M

SMPTE240M: "SMPTE240M"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

YCGCO

YCGCO: "YCGCO"

YCOCG

YCOCG: "YCOCG"

Settings

Member Visibility

Theme

On This Page

BT2020_CLBT2020_NCLBT470BGBT709FCCRGBSMPTE170MSMPTE2085SMPTE240MUNSPECIFIEDYCGCOYCOCG
\ No newline at end of file +

Enumeration Members

BT2020_CL

BT2020_CL: "BT2020_CL"

BT2020_NCL

BT2020_NCL: "BT2020_NCL"

BT470BG

BT470BG: "BT470BG"

BT709

BT709: "BT709"

FCC

FCC: "FCC"

RGB

RGB: "RGB"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE2085

SMPTE2085: "SMPTE2085"

SMPTE240M

SMPTE240M: "SMPTE240M"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

YCGCO

YCGCO: "YCGCO"

YCOCG

YCOCG: "YCOCG"

Settings

Member Visibility

Theme

On This Page

BT2020_CLBT2020_NCLBT470BGBT709FCCRGBSMPTE170MSMPTE2085SMPTE240MUNSPECIFIEDYCGCOYCOCG
\ No newline at end of file diff --git a/docs/enums/ColorTransfer.html b/docs/enums/ColorTransfer.html index 23ed05d70..d4b104782 100644 --- a/docs/enums/ColorTransfer.html +++ b/docs/enums/ColorTransfer.html @@ -1,4 +1,4 @@ -ColorTransfer | @bitmovin/api-sdk

Enumeration ColorTransfer

Export

Enumeration Members

ARIB_STD_B67 +ColorTransfer | @bitmovin/api-sdk

Enumeration ColorTransfer

Export

Enumeration Members

ARIB_STD_B67 BT1361_ECG BT2020_10 BT2020_12 @@ -15,4 +15,4 @@ SMPTE240M SMPTE428 UNSPECIFIED -

Enumeration Members

ARIB_STD_B67

ARIB_STD_B67: "ARIB_STD_B67"

BT1361_ECG

BT1361_ECG: "BT1361_ECG"

BT2020_10

BT2020_10: "BT2020_10"

BT2020_12

BT2020_12: "BT2020_12"

BT709

BT709: "BT709"

GAMMA22

GAMMA22: "GAMMA22"

GAMMA28

GAMMA28: "GAMMA28"

IEC61966_2_1

IEC61966_2_1: "IEC61966_2_1"

IEC61966_2_4

IEC61966_2_4: "IEC61966_2_4"

LINEAR

LINEAR: "LINEAR"

LOG

LOG: "LOG"

LOG_SQRT

LOG_SQRT: "LOG_SQRT"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE2084

SMPTE2084: "SMPTE2084"

SMPTE240M

SMPTE240M: "SMPTE240M"

SMPTE428

SMPTE428: "SMPTE428"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

ARIB_STD_B67BT1361_ECGBT2020_10BT2020_12BT709GAMMA22GAMMA28IEC61966_2_1IEC61966_2_4LINEARLOGLOG_SQRTSMPTE170MSMPTE2084SMPTE240MSMPTE428UNSPECIFIED
\ No newline at end of file +

Enumeration Members

ARIB_STD_B67

ARIB_STD_B67: "ARIB_STD_B67"

BT1361_ECG

BT1361_ECG: "BT1361_ECG"

BT2020_10

BT2020_10: "BT2020_10"

BT2020_12

BT2020_12: "BT2020_12"

BT709

BT709: "BT709"

GAMMA22

GAMMA22: "GAMMA22"

GAMMA28

GAMMA28: "GAMMA28"

IEC61966_2_1

IEC61966_2_1: "IEC61966_2_1"

IEC61966_2_4

IEC61966_2_4: "IEC61966_2_4"

LINEAR

LINEAR: "LINEAR"

LOG

LOG: "LOG"

LOG_SQRT

LOG_SQRT: "LOG_SQRT"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE2084

SMPTE2084: "SMPTE2084"

SMPTE240M

SMPTE240M: "SMPTE240M"

SMPTE428

SMPTE428: "SMPTE428"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

ARIB_STD_B67BT1361_ECGBT2020_10BT2020_12BT709GAMMA22GAMMA28IEC61966_2_1IEC61966_2_4LINEARLOGLOG_SQRTSMPTE170MSMPTE2084SMPTE240MSMPTE428UNSPECIFIED
\ No newline at end of file diff --git a/docs/enums/ConditionAttribute.html b/docs/enums/ConditionAttribute.html index f3917ec2e..609a47e28 100644 --- a/docs/enums/ConditionAttribute.html +++ b/docs/enums/ConditionAttribute.html @@ -1,5 +1,5 @@ ConditionAttribute | @bitmovin/api-sdk

Enumeration ConditionAttribute

The attribute that should be checked

-

Export

Enumeration Members

ASPECTRATIO +

Export

Enumeration Members

ASPECTRATIO AUDIOSTREAMCOUNT BITRATE CHANNELFORMAT @@ -15,4 +15,4 @@ STREAMCOUNT VIDEOSTREAMCOUNT WIDTH -

Enumeration Members

ASPECTRATIO

ASPECTRATIO: "ASPECTRATIO"

AUDIOSTREAMCOUNT

AUDIOSTREAMCOUNT: "AUDIOSTREAMCOUNT"

BITRATE

BITRATE: "BITRATE"

CHANNELFORMAT

CHANNELFORMAT: "CHANNELFORMAT"

CHANNELLAYOUT

CHANNELLAYOUT: "CHANNELLAYOUT"

CONNECTION_STATUS

CONNECTION_STATUS: "CONNECTION_STATUS"

CONNECTION_STATUS_JUST_CHANGED

CONNECTION_STATUS_JUST_CHANGED: "CONNECTION_STATUS_JUST_CHANGED"

DURATION

DURATION: "DURATION"

FPS

FPS: "FPS"

HEIGHT

HEIGHT: "HEIGHT"

INPUTSTREAM

INPUTSTREAM: "INPUTSTREAM"

LANGUAGE

LANGUAGE: "LANGUAGE"

ROTATION

ROTATION: "ROTATION"

STREAMCOUNT

STREAMCOUNT: "STREAMCOUNT"

VIDEOSTREAMCOUNT

VIDEOSTREAMCOUNT: "VIDEOSTREAMCOUNT"

WIDTH

WIDTH: "WIDTH"

Settings

Member Visibility

Theme

On This Page

ASPECTRATIOAUDIOSTREAMCOUNTBITRATECHANNELFORMATCHANNELLAYOUTCONNECTION_STATUSCONNECTION_STATUS_JUST_CHANGEDDURATIONFPSHEIGHTINPUTSTREAMLANGUAGEROTATIONSTREAMCOUNTVIDEOSTREAMCOUNTWIDTH
\ No newline at end of file +

Enumeration Members

ASPECTRATIO

ASPECTRATIO: "ASPECTRATIO"

AUDIOSTREAMCOUNT

AUDIOSTREAMCOUNT: "AUDIOSTREAMCOUNT"

BITRATE

BITRATE: "BITRATE"

CHANNELFORMAT

CHANNELFORMAT: "CHANNELFORMAT"

CHANNELLAYOUT

CHANNELLAYOUT: "CHANNELLAYOUT"

CONNECTION_STATUS

CONNECTION_STATUS: "CONNECTION_STATUS"

CONNECTION_STATUS_JUST_CHANGED

CONNECTION_STATUS_JUST_CHANGED: "CONNECTION_STATUS_JUST_CHANGED"

DURATION

DURATION: "DURATION"

FPS

FPS: "FPS"

HEIGHT

HEIGHT: "HEIGHT"

INPUTSTREAM

INPUTSTREAM: "INPUTSTREAM"

LANGUAGE

LANGUAGE: "LANGUAGE"

ROTATION

ROTATION: "ROTATION"

STREAMCOUNT

STREAMCOUNT: "STREAMCOUNT"

VIDEOSTREAMCOUNT

VIDEOSTREAMCOUNT: "VIDEOSTREAMCOUNT"

WIDTH

WIDTH: "WIDTH"

Settings

Member Visibility

Theme

On This Page

ASPECTRATIOAUDIOSTREAMCOUNTBITRATECHANNELFORMATCHANNELLAYOUTCONNECTION_STATUSCONNECTION_STATUS_JUST_CHANGEDDURATIONFPSHEIGHTINPUTSTREAMLANGUAGEROTATIONSTREAMCOUNTVIDEOSTREAMCOUNTWIDTH
\ No newline at end of file diff --git a/docs/enums/ConditionOperator.html b/docs/enums/ConditionOperator.html index 904c09cb1..72e804b07 100644 --- a/docs/enums/ConditionOperator.html +++ b/docs/enums/ConditionOperator.html @@ -1,8 +1,8 @@ ConditionOperator | @bitmovin/api-sdk

Enumeration ConditionOperator

The operator that should be used for the evaluation

-

Export

Enumeration Members

EQUAL +

Export

Enumeration Members

EQUAL GREATER_THAN GREATER_THAN_OR_EQUAL LESS_THAN LESS_THAN_OR_EQUAL NOT_EQUAL -

Enumeration Members

EQUAL

EQUAL: "=="

GREATER_THAN

GREATER_THAN: ">"

GREATER_THAN_OR_EQUAL

GREATER_THAN_OR_EQUAL: ">="

LESS_THAN

LESS_THAN: "<"

LESS_THAN_OR_EQUAL

LESS_THAN_OR_EQUAL: "<="

NOT_EQUAL

NOT_EQUAL: "!="

Settings

Member Visibility

Theme

On This Page

EQUALGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALNOT_EQUAL
\ No newline at end of file +

Enumeration Members

EQUAL

EQUAL: "=="

GREATER_THAN

GREATER_THAN: ">"

GREATER_THAN_OR_EQUAL

GREATER_THAN_OR_EQUAL: ">="

LESS_THAN

LESS_THAN: "<"

LESS_THAN_OR_EQUAL

LESS_THAN_OR_EQUAL: "<="

NOT_EQUAL

NOT_EQUAL: "!="

Settings

Member Visibility

Theme

On This Page

EQUALGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALNOT_EQUAL
\ No newline at end of file diff --git a/docs/enums/ConditionType.html b/docs/enums/ConditionType.html index d043b1229..87219ba1f 100644 --- a/docs/enums/ConditionType.html +++ b/docs/enums/ConditionType.html @@ -1,5 +1,5 @@ ConditionType | @bitmovin/api-sdk

Enumeration ConditionType

Type of the condition

-

Export

Enumeration Members

AND +

Export

Enumeration Members

AND CONDITION OR -

Enumeration Members

AND

AND: "AND"

CONDITION

CONDITION: "CONDITION"

OR

OR: "OR"

Settings

Member Visibility

Theme

On This Page

ANDCONDITIONOR
\ No newline at end of file +

Enumeration Members

AND

AND: "AND"

CONDITION

CONDITION: "CONDITION"

OR

OR: "OR"

Settings

Member Visibility

Theme

On This Page

ANDCONDITIONOR
\ No newline at end of file diff --git a/docs/enums/ConvertSccPositionMode.html b/docs/enums/ConvertSccPositionMode.html index 39a9bad52..a6eab1a73 100644 --- a/docs/enums/ConvertSccPositionMode.html +++ b/docs/enums/ConvertSccPositionMode.html @@ -1,4 +1,4 @@ -ConvertSccPositionMode | @bitmovin/api-sdk

Enumeration ConvertSccPositionMode

Export

Enumeration Members

FULL +ConvertSccPositionMode | @bitmovin/api-sdk

Enumeration ConvertSccPositionMode

Export

Enumeration Members

FULL NONE SIMPLE -

Enumeration Members

FULL

FULL: "FULL"

NONE

NONE: "NONE"

SIMPLE

SIMPLE: "SIMPLE"

Settings

Member Visibility

Theme

On This Page

FULLNONESIMPLE
\ No newline at end of file +

Enumeration Members

FULL

FULL: "FULL"

NONE

NONE: "NONE"

SIMPLE

SIMPLE: "SIMPLE"

Settings

Member Visibility

Theme

On This Page

FULLNONESIMPLE
\ No newline at end of file diff --git a/docs/enums/DashEditionCompatibility.html b/docs/enums/DashEditionCompatibility.html index 94588bcab..d2280f6eb 100644 --- a/docs/enums/DashEditionCompatibility.html +++ b/docs/enums/DashEditionCompatibility.html @@ -1,2 +1,2 @@ -DashEditionCompatibility | @bitmovin/api-sdk

Enumeration DashEditionCompatibility

Export

Enumeration Members

V4 -

Enumeration Members

V4

V4: "V4"

Settings

Member Visibility

Theme

On This Page

V4
\ No newline at end of file +DashEditionCompatibility | @bitmovin/api-sdk

Enumeration DashEditionCompatibility

Export

Enumeration Members

V4 +

Enumeration Members

V4

V4: "V4"

Settings

Member Visibility

Theme

On This Page

V4
\ No newline at end of file diff --git a/docs/enums/DashManifestDefaultVersion.html b/docs/enums/DashManifestDefaultVersion.html index 3e6674b18..7983db405 100644 --- a/docs/enums/DashManifestDefaultVersion.html +++ b/docs/enums/DashManifestDefaultVersion.html @@ -1,3 +1,3 @@ -DashManifestDefaultVersion | @bitmovin/api-sdk

Enumeration DashManifestDefaultVersion

Export

Enumeration Members

V1 +DashManifestDefaultVersion | @bitmovin/api-sdk

Enumeration DashManifestDefaultVersion

Export

Enumeration Members

V1 V2 -

Enumeration Members

V1

V1: "V1"

V2

V2: "V2"

Settings

Member Visibility

Theme

On This Page

V1V2
\ No newline at end of file +

Enumeration Members

V1

V1: "V1"

V2

V2: "V2"

Settings

Member Visibility

Theme

On This Page

V1V2
\ No newline at end of file diff --git a/docs/enums/DashOnDemandRepresentationType.html b/docs/enums/DashOnDemandRepresentationType.html index 959013b49..041427bb7 100644 --- a/docs/enums/DashOnDemandRepresentationType.html +++ b/docs/enums/DashOnDemandRepresentationType.html @@ -1,3 +1,3 @@ -DashOnDemandRepresentationType | @bitmovin/api-sdk

Enumeration DashOnDemandRepresentationType

Export

Enumeration Members

SEGMENT_BASE +DashOnDemandRepresentationType | @bitmovin/api-sdk

Enumeration DashOnDemandRepresentationType

Export

Enumeration Members

SEGMENT_BASE SEGMENT_LIST -

Enumeration Members

SEGMENT_BASE

SEGMENT_BASE: "SEGMENT_BASE"

SEGMENT_LIST

SEGMENT_LIST: "SEGMENT_LIST"

Settings

Member Visibility

Theme

On This Page

SEGMENT_BASESEGMENT_LIST
\ No newline at end of file +

Enumeration Members

SEGMENT_BASE

SEGMENT_BASE: "SEGMENT_BASE"

SEGMENT_LIST

SEGMENT_LIST: "SEGMENT_LIST"

Settings

Member Visibility

Theme

On This Page

SEGMENT_BASESEGMENT_LIST
\ No newline at end of file diff --git a/docs/enums/DashProfile.html b/docs/enums/DashProfile.html index 2ac686ea0..9c1d39b57 100644 --- a/docs/enums/DashProfile.html +++ b/docs/enums/DashProfile.html @@ -1,3 +1,3 @@ -DashProfile | @bitmovin/api-sdk

Enumeration DashProfile

Export

Enumeration Members

LIVE +DashProfile | @bitmovin/api-sdk

Enumeration DashProfile

Export

Enumeration Members

LIVE ON_DEMAND -

Enumeration Members

LIVE

LIVE: "LIVE"

ON_DEMAND

ON_DEMAND: "ON_DEMAND"

Settings

Member Visibility

Theme

On This Page

LIVEON_DEMAND
\ No newline at end of file +

Enumeration Members

LIVE

LIVE: "LIVE"

ON_DEMAND

ON_DEMAND: "ON_DEMAND"

Settings

Member Visibility

Theme

On This Page

LIVEON_DEMAND
\ No newline at end of file diff --git a/docs/enums/DashRepresentationType.html b/docs/enums/DashRepresentationType.html index 2f8ff6208..3bcbc663f 100644 --- a/docs/enums/DashRepresentationType.html +++ b/docs/enums/DashRepresentationType.html @@ -1,4 +1,4 @@ -DashRepresentationType | @bitmovin/api-sdk

Enumeration DashRepresentationType

Export

Enumeration Members

LIST +DashRepresentationType | @bitmovin/api-sdk

Enumeration DashRepresentationType

Export

Enumeration Members

LIST TEMPLATE TIMELINE -

Enumeration Members

LIST

LIST: "LIST"

TEMPLATE

TEMPLATE: "TEMPLATE"

TIMELINE

TIMELINE: "TIMELINE"

Settings

Member Visibility

Theme

On This Page

LISTTEMPLATETIMELINE
\ No newline at end of file +

Enumeration Members

LIST

LIST: "LIST"

TEMPLATE

TEMPLATE: "TEMPLATE"

TIMELINE

TIMELINE: "TIMELINE"

Settings

Member Visibility

Theme

On This Page

LISTTEMPLATETIMELINE
\ No newline at end of file diff --git a/docs/enums/DashRepresentationTypeDiscriminator.html b/docs/enums/DashRepresentationTypeDiscriminator.html index 238960aae..f5bd4007c 100644 --- a/docs/enums/DashRepresentationTypeDiscriminator.html +++ b/docs/enums/DashRepresentationTypeDiscriminator.html @@ -1,4 +1,4 @@ -DashRepresentationTypeDiscriminator | @bitmovin/api-sdk

Enumeration DashRepresentationTypeDiscriminator

Export

Enumeration Members

CHUNKED_TEXT +DashRepresentationTypeDiscriminator | @bitmovin/api-sdk

Enumeration DashRepresentationTypeDiscriminator

Export

Enumeration Members

CHUNKED_TEXT CMAF CONTENT_PROTECTION DRM_FMP4 @@ -10,4 +10,4 @@ SPRITE VTT WEBM -

Enumeration Members

CHUNKED_TEXT

CHUNKED_TEXT: "CHUNKED_TEXT"

CMAF

CMAF: "CMAF"

CONTENT_PROTECTION

CONTENT_PROTECTION: "CONTENT_PROTECTION"

DRM_FMP4

DRM_FMP4: "DRM_FMP4"

DRM_MP4

DRM_MP4: "DRM_MP4"

FMP4

FMP4: "FMP4"

IMSC

IMSC: "IMSC"

MP4

MP4: "MP4"

PROGRESSIVE_WEBM

PROGRESSIVE_WEBM: "PROGRESSIVE_WEBM"

SPRITE

SPRITE: "SPRITE"

VTT

VTT: "VTT"

WEBM

WEBM: "WEBM"

Settings

Member Visibility

Theme

On This Page

CHUNKED_TEXTCMAFCONTENT_PROTECTIONDRM_FMP4DRM_MP4FMP4IMSCMP4PROGRESSIVE_WEBMSPRITEVTTWEBM
\ No newline at end of file +

Enumeration Members

CHUNKED_TEXT

CHUNKED_TEXT: "CHUNKED_TEXT"

CMAF

CMAF: "CMAF"

CONTENT_PROTECTION

CONTENT_PROTECTION: "CONTENT_PROTECTION"

DRM_FMP4

DRM_FMP4: "DRM_FMP4"

DRM_MP4

DRM_MP4: "DRM_MP4"

FMP4

FMP4: "FMP4"

IMSC

IMSC: "IMSC"

MP4

MP4: "MP4"

PROGRESSIVE_WEBM

PROGRESSIVE_WEBM: "PROGRESSIVE_WEBM"

SPRITE

SPRITE: "SPRITE"

VTT

VTT: "VTT"

WEBM

WEBM: "WEBM"

Settings

Member Visibility

Theme

On This Page

CHUNKED_TEXTCMAFCONTENT_PROTECTIONDRM_FMP4DRM_MP4FMP4IMSCMP4PROGRESSIVE_WEBMSPRITEVTTWEBM
\ No newline at end of file diff --git a/docs/enums/DashRepresentationTypeMode.html b/docs/enums/DashRepresentationTypeMode.html index 2050057ee..b117a779d 100644 --- a/docs/enums/DashRepresentationTypeMode.html +++ b/docs/enums/DashRepresentationTypeMode.html @@ -1,3 +1,3 @@ -DashRepresentationTypeMode | @bitmovin/api-sdk

Enumeration DashRepresentationTypeMode

Export

Enumeration Members

TEMPLATE_ADAPTATION_SET +DashRepresentationTypeMode | @bitmovin/api-sdk

Enumeration DashRepresentationTypeMode

Export

Enumeration Members

TEMPLATE_ADAPTATION_SET TEMPLATE_REPRESENTATION -

Enumeration Members

TEMPLATE_ADAPTATION_SET

TEMPLATE_ADAPTATION_SET: "TEMPLATE_ADAPTATION_SET"

TEMPLATE_REPRESENTATION

TEMPLATE_REPRESENTATION: "TEMPLATE_REPRESENTATION"

Settings

Member Visibility

Theme

On This Page

TEMPLATE_ADAPTATION_SETTEMPLATE_REPRESENTATION
\ No newline at end of file +

Enumeration Members

TEMPLATE_ADAPTATION_SET

TEMPLATE_ADAPTATION_SET: "TEMPLATE_ADAPTATION_SET"

TEMPLATE_REPRESENTATION

TEMPLATE_REPRESENTATION: "TEMPLATE_REPRESENTATION"

Settings

Member Visibility

Theme

On This Page

TEMPLATE_ADAPTATION_SETTEMPLATE_REPRESENTATION
\ No newline at end of file diff --git a/docs/enums/DecodingErrorMode.html b/docs/enums/DecodingErrorMode.html index d217fbe47..547dad67f 100644 --- a/docs/enums/DecodingErrorMode.html +++ b/docs/enums/DecodingErrorMode.html @@ -1,3 +1,3 @@ -DecodingErrorMode | @bitmovin/api-sdk

Enumeration DecodingErrorMode

Export

Enumeration Members

DUPLICATE_FRAMES +DecodingErrorMode | @bitmovin/api-sdk

Enumeration DecodingErrorMode

Export

Enumeration Members

DUPLICATE_FRAMES FAIL_ON_ERROR -

Enumeration Members

DUPLICATE_FRAMES

DUPLICATE_FRAMES: "DUPLICATE_FRAMES"

FAIL_ON_ERROR

FAIL_ON_ERROR: "FAIL_ON_ERROR"

Settings

Member Visibility

Theme

On This Page

DUPLICATE_FRAMESFAIL_ON_ERROR
\ No newline at end of file +

Enumeration Members

DUPLICATE_FRAMES

DUPLICATE_FRAMES: "DUPLICATE_FRAMES"

FAIL_ON_ERROR

FAIL_ON_ERROR: "FAIL_ON_ERROR"

Settings

Member Visibility

Theme

On This Page

DUPLICATE_FRAMESFAIL_ON_ERROR
\ No newline at end of file diff --git a/docs/enums/DeinterlaceAutoEnable.html b/docs/enums/DeinterlaceAutoEnable.html index 1f22391e7..102d15e3d 100644 --- a/docs/enums/DeinterlaceAutoEnable.html +++ b/docs/enums/DeinterlaceAutoEnable.html @@ -1,5 +1,5 @@ DeinterlaceAutoEnable | @bitmovin/api-sdk

Enumeration DeinterlaceAutoEnable

Specifies if the Deinterlace Filter should be applied unconditionally or only on demand.

-

Export

Enumeration Members

ALWAYS_ON +

Export

Enumeration Members

ALWAYS_ON META_DATA_AND_CONTENT_BASED META_DATA_BASED -

Enumeration Members

ALWAYS_ON

ALWAYS_ON: "ALWAYS_ON"

META_DATA_AND_CONTENT_BASED

META_DATA_AND_CONTENT_BASED: "META_DATA_AND_CONTENT_BASED"

META_DATA_BASED

META_DATA_BASED: "META_DATA_BASED"

Settings

Member Visibility

Theme

On This Page

ALWAYS_ONMETA_DATA_AND_CONTENT_BASEDMETA_DATA_BASED
\ No newline at end of file +

Enumeration Members

ALWAYS_ON

ALWAYS_ON: "ALWAYS_ON"

META_DATA_AND_CONTENT_BASED

META_DATA_AND_CONTENT_BASED: "META_DATA_AND_CONTENT_BASED"

META_DATA_BASED

META_DATA_BASED: "META_DATA_BASED"

Settings

Member Visibility

Theme

On This Page

ALWAYS_ONMETA_DATA_AND_CONTENT_BASEDMETA_DATA_BASED
\ No newline at end of file diff --git a/docs/enums/DeinterlaceFrameSelectionMode.html b/docs/enums/DeinterlaceFrameSelectionMode.html index 79682b881..d1ae16a39 100644 --- a/docs/enums/DeinterlaceFrameSelectionMode.html +++ b/docs/enums/DeinterlaceFrameSelectionMode.html @@ -1,4 +1,4 @@ DeinterlaceFrameSelectionMode | @bitmovin/api-sdk

Enumeration DeinterlaceFrameSelectionMode

Specifies which frames to deinterlace

-

Export

Enumeration Members

ALL +

Export

Enumeration Members

ALL INTERLACED -

Enumeration Members

ALL

ALL: "ALL"

INTERLACED

INTERLACED: "INTERLACED"

Settings

Member Visibility

Theme

On This Page

ALLINTERLACED
\ No newline at end of file +

Enumeration Members

ALL

ALL: "ALL"

INTERLACED

INTERLACED: "INTERLACED"

Settings

Member Visibility

Theme

On This Page

ALLINTERLACED
\ No newline at end of file diff --git a/docs/enums/DeinterlaceMode.html b/docs/enums/DeinterlaceMode.html index 1bf340c43..5f4151fa6 100644 --- a/docs/enums/DeinterlaceMode.html +++ b/docs/enums/DeinterlaceMode.html @@ -1,6 +1,6 @@ DeinterlaceMode | @bitmovin/api-sdk

Enumeration DeinterlaceMode

Specifies the method how fields are converted to frames

-

Export

Enumeration Members

FIELD +

Export

Enumeration Members

FIELD FIELD_NOSPATIAL FRAME FRAME_NOSPATIAL -

Enumeration Members

FIELD

FIELD: "FIELD"

FIELD_NOSPATIAL

FIELD_NOSPATIAL: "FIELD_NOSPATIAL"

FRAME

FRAME: "FRAME"

FRAME_NOSPATIAL

FRAME_NOSPATIAL: "FRAME_NOSPATIAL"

Settings

Member Visibility

Theme

On This Page

FIELDFIELD_NOSPATIALFRAMEFRAME_NOSPATIAL
\ No newline at end of file +

Enumeration Members

FIELD

FIELD: "FIELD"

FIELD_NOSPATIAL

FIELD_NOSPATIAL: "FIELD_NOSPATIAL"

FRAME

FRAME: "FRAME"

FRAME_NOSPATIAL

FRAME_NOSPATIAL: "FRAME_NOSPATIAL"

Settings

Member Visibility

Theme

On This Page

FIELDFIELD_NOSPATIALFRAMEFRAME_NOSPATIAL
\ No newline at end of file diff --git a/docs/enums/DolbyAtmosDialogueIntelligence.html b/docs/enums/DolbyAtmosDialogueIntelligence.html index 92365fd67..7a647a920 100644 --- a/docs/enums/DolbyAtmosDialogueIntelligence.html +++ b/docs/enums/DolbyAtmosDialogueIntelligence.html @@ -1,4 +1,4 @@ DolbyAtmosDialogueIntelligence | @bitmovin/api-sdk

Enumeration DolbyAtmosDialogueIntelligence

Whether to use the Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyAtmosInputFormat.html b/docs/enums/DolbyAtmosInputFormat.html index 19d66d834..f983095d1 100644 --- a/docs/enums/DolbyAtmosInputFormat.html +++ b/docs/enums/DolbyAtmosInputFormat.html @@ -1,3 +1,3 @@ -DolbyAtmosInputFormat | @bitmovin/api-sdk

Enumeration DolbyAtmosInputFormat

Export

Enumeration Members

ADM +DolbyAtmosInputFormat | @bitmovin/api-sdk

Enumeration DolbyAtmosInputFormat

Export

Enumeration Members

ADM DAMF -

Enumeration Members

ADM

ADM: "ADM"

DAMF

DAMF: "DAMF"

Settings

Member Visibility

Theme

On This Page

ADMDAMF
\ No newline at end of file +

Enumeration Members

ADM

ADM: "ADM"

DAMF

DAMF: "DAMF"

Settings

Member Visibility

Theme

On This Page

ADMDAMF
\ No newline at end of file diff --git a/docs/enums/DolbyAtmosMeteringMode.html b/docs/enums/DolbyAtmosMeteringMode.html index a12a207ce..1f1c52238 100644 --- a/docs/enums/DolbyAtmosMeteringMode.html +++ b/docs/enums/DolbyAtmosMeteringMode.html @@ -1,7 +1,7 @@ DolbyAtmosMeteringMode | @bitmovin/api-sdk

Enumeration DolbyAtmosMeteringMode

Algorithm to be used for measuring loudness

-

Export

Enumeration Members

ITU_R_BS_1770_1 +

Export

Enumeration Members

ITU_R_BS_1770_1 ITU_R_BS_1770_2 ITU_R_BS_1770_3 ITU_R_BS_1770_4 LEQ_A -

Enumeration Members

ITU_R_BS_1770_1

ITU_R_BS_1770_1: "ITU-R BS.1770-1"

ITU_R_BS_1770_2

ITU_R_BS_1770_2: "ITU-R BS.1770-2"

ITU_R_BS_1770_3

ITU_R_BS_1770_3: "ITU-R BS.1770-3"

ITU_R_BS_1770_4

ITU_R_BS_1770_4: "ITU-R BS.1770-4"

LEQ_A

LEQ_A: "Leq (A)"

Settings

Member Visibility

Theme

On This Page

ITU_R_BS_1770_1ITU_R_BS_1770_2ITU_R_BS_1770_3ITU_R_BS_1770_4LEQ_A
\ No newline at end of file +

Enumeration Members

ITU_R_BS_1770_1

ITU_R_BS_1770_1: "ITU-R BS.1770-1"

ITU_R_BS_1770_2

ITU_R_BS_1770_2: "ITU-R BS.1770-2"

ITU_R_BS_1770_3

ITU_R_BS_1770_3: "ITU-R BS.1770-3"

ITU_R_BS_1770_4

ITU_R_BS_1770_4: "ITU-R BS.1770-4"

LEQ_A

LEQ_A: "Leq (A)"

Settings

Member Visibility

Theme

On This Page

ITU_R_BS_1770_1ITU_R_BS_1770_2ITU_R_BS_1770_3ITU_R_BS_1770_4LEQ_A
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalCenterMixLevel.html b/docs/enums/DolbyDigitalCenterMixLevel.html index ec7becfd6..c716a7eff 100644 --- a/docs/enums/DolbyDigitalCenterMixLevel.html +++ b/docs/enums/DolbyDigitalCenterMixLevel.html @@ -1,4 +1,4 @@ -DolbyDigitalCenterMixLevel | @bitmovin/api-sdk

Enumeration DolbyDigitalCenterMixLevel

Export

Enumeration Members

MINUS_1_5_DB +DolbyDigitalCenterMixLevel | @bitmovin/api-sdk

Enumeration DolbyDigitalCenterMixLevel

Export

Enumeration Members

MINUS_1_5_DB MINUS_3_DB MINUS_4_5_DB MINUS_6_DB @@ -6,4 +6,4 @@ PLUS_1_5_DB PLUS_3_DB ZERO_DB -

Enumeration Members

MINUS_1_5_DB

MINUS_1_5_DB: "MINUS_1_5_DB"

MINUS_3_DB

MINUS_3_DB: "MINUS_3_DB"

MINUS_4_5_DB

MINUS_4_5_DB: "MINUS_4_5_DB"

MINUS_6_DB

MINUS_6_DB: "MINUS_6_DB"

MINUS_INFINITY_DB

MINUS_INFINITY_DB: "MINUS_INFINITY_DB"

PLUS_1_5_DB

PLUS_1_5_DB: "PLUS_1_5_DB"

PLUS_3_DB

PLUS_3_DB: "PLUS_3_DB"

ZERO_DB

ZERO_DB: "ZERO_DB"

Settings

Member Visibility

Theme

On This Page

MINUS_1_5_DBMINUS_3_DBMINUS_4_5_DBMINUS_6_DBMINUS_INFINITY_DBPLUS_1_5_DBPLUS_3_DBZERO_DB
\ No newline at end of file +

Enumeration Members

MINUS_1_5_DB

MINUS_1_5_DB: "MINUS_1_5_DB"

MINUS_3_DB

MINUS_3_DB: "MINUS_3_DB"

MINUS_4_5_DB

MINUS_4_5_DB: "MINUS_4_5_DB"

MINUS_6_DB

MINUS_6_DB: "MINUS_6_DB"

MINUS_INFINITY_DB

MINUS_INFINITY_DB: "MINUS_INFINITY_DB"

PLUS_1_5_DB

PLUS_1_5_DB: "PLUS_1_5_DB"

PLUS_3_DB

PLUS_3_DB: "PLUS_3_DB"

ZERO_DB

ZERO_DB: "ZERO_DB"

Settings

Member Visibility

Theme

On This Page

MINUS_1_5_DBMINUS_3_DBMINUS_4_5_DBMINUS_6_DBMINUS_INFINITY_DBPLUS_1_5_DBPLUS_3_DBZERO_DB
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalChannelLayout.html b/docs/enums/DolbyDigitalChannelLayout.html index 55cc5f172..136d6a080 100644 --- a/docs/enums/DolbyDigitalChannelLayout.html +++ b/docs/enums/DolbyDigitalChannelLayout.html @@ -1,4 +1,4 @@ -DolbyDigitalChannelLayout | @bitmovin/api-sdk

Enumeration DolbyDigitalChannelLayout

Export

Enumeration Members

CL_3_1 +DolbyDigitalChannelLayout | @bitmovin/api-sdk

Enumeration DolbyDigitalChannelLayout

Export

Enumeration Members

CL_3_1 CL_4_0 CL_4_1 CL_5_0 @@ -11,4 +11,4 @@ CL_SURROUND MONO NONE -

Enumeration Members

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_1

CL_5_1: "5.1"

CL_BACK_SURROUND

CL_BACK_SURROUND: "BACK_SURROUND"

CL_BACK_SURROUND_LFE

CL_BACK_SURROUND_LFE: "BACK_SURROUND_LFE"

CL_QUAD

CL_QUAD: "QUAD"

CL_QUAD_LFE

CL_QUAD_LFE: "QUAD_LFE"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_3_1CL_4_0CL_4_1CL_5_0CL_5_1CL_BACK_SURROUNDCL_BACK_SURROUND_LFECL_QUADCL_QUAD_LFECL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file +

Enumeration Members

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_1

CL_5_1: "5.1"

CL_BACK_SURROUND

CL_BACK_SURROUND: "BACK_SURROUND"

CL_BACK_SURROUND_LFE

CL_BACK_SURROUND_LFE: "BACK_SURROUND_LFE"

CL_QUAD

CL_QUAD: "QUAD"

CL_QUAD_LFE

CL_QUAD_LFE: "QUAD_LFE"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_3_1CL_4_0CL_4_1CL_5_0CL_5_1CL_BACK_SURROUNDCL_BACK_SURROUND_LFECL_QUADCL_QUAD_LFECL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalDialogueIntelligence.html b/docs/enums/DolbyDigitalDialogueIntelligence.html index d82d5e212..4a17b7e9e 100644 --- a/docs/enums/DolbyDigitalDialogueIntelligence.html +++ b/docs/enums/DolbyDigitalDialogueIntelligence.html @@ -1,4 +1,4 @@ DolbyDigitalDialogueIntelligence | @bitmovin/api-sdk

Enumeration DolbyDigitalDialogueIntelligence

Whether to use the Dolby Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalDownmixingPreferredMode.html b/docs/enums/DolbyDigitalDownmixingPreferredMode.html index 52413c23c..62d201b6c 100644 --- a/docs/enums/DolbyDigitalDownmixingPreferredMode.html +++ b/docs/enums/DolbyDigitalDownmixingPreferredMode.html @@ -1,5 +1,5 @@ DolbyDigitalDownmixingPreferredMode | @bitmovin/api-sdk

Enumeration DolbyDigitalDownmixingPreferredMode

It indicates if downmixing mode is Dolby Surround compatible (LT_RT: Left total/Right total) or Dolby Pro Logic II (PRO_LOGIC_II). LO_RO for Left only/Right only: A downmix from a multichannel to a two‐channel output that is compatible for stereo or mono reproduction.

-

Export

Enumeration Members

LO_RO +

Export

Enumeration Members

LO_RO LT_RT PRO_LOGIC_II -

Enumeration Members

LO_RO

LO_RO: "LO_RO"

LT_RT

LT_RT: "LT_RT"

PRO_LOGIC_II

PRO_LOGIC_II: "PRO_LOGIC_II"

Settings

Member Visibility

Theme

On This Page

LO_ROLT_RTPRO_LOGIC_II
\ No newline at end of file +

Enumeration Members

LO_RO

LO_RO: "LO_RO"

LT_RT

LT_RT: "LT_RT"

PRO_LOGIC_II

PRO_LOGIC_II: "PRO_LOGIC_II"

Settings

Member Visibility

Theme

On This Page

LO_ROLT_RTPRO_LOGIC_II
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalDynamicRangeCompressionMode.html b/docs/enums/DolbyDigitalDynamicRangeCompressionMode.html index 68caa1bab..d23a6aad6 100644 --- a/docs/enums/DolbyDigitalDynamicRangeCompressionMode.html +++ b/docs/enums/DolbyDigitalDynamicRangeCompressionMode.html @@ -1,8 +1,8 @@ DolbyDigitalDynamicRangeCompressionMode | @bitmovin/api-sdk

Enumeration DolbyDigitalDynamicRangeCompressionMode

Dynamic range compression processing mode

-

Export

Enumeration Members

FILM_LIGHT +

Export

Enumeration Members

FILM_LIGHT FILM_STANDARD MUSIC_LIGHT MUSIC_STANDARD NONE SPEECH -

Enumeration Members

FILM_LIGHT

FILM_LIGHT: "FILM_LIGHT"

FILM_STANDARD

FILM_STANDARD: "FILM_STANDARD"

MUSIC_LIGHT

MUSIC_LIGHT: "MUSIC_LIGHT"

MUSIC_STANDARD

MUSIC_STANDARD: "MUSIC_STANDARD"

NONE

NONE: "NONE"

SPEECH

SPEECH: "SPEECH"

Settings

Member Visibility

Theme

On This Page

FILM_LIGHTFILM_STANDARDMUSIC_LIGHTMUSIC_STANDARDNONESPEECH
\ No newline at end of file +

Enumeration Members

FILM_LIGHT

FILM_LIGHT: "FILM_LIGHT"

FILM_STANDARD

FILM_STANDARD: "FILM_STANDARD"

MUSIC_LIGHT

MUSIC_LIGHT: "MUSIC_LIGHT"

MUSIC_STANDARD

MUSIC_STANDARD: "MUSIC_STANDARD"

NONE

NONE: "NONE"

SPEECH

SPEECH: "SPEECH"

Settings

Member Visibility

Theme

On This Page

FILM_LIGHTFILM_STANDARDMUSIC_LIGHTMUSIC_STANDARDNONESPEECH
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalEvolutionFrameworkControl.html b/docs/enums/DolbyDigitalEvolutionFrameworkControl.html index 0198c2055..babd481c4 100644 --- a/docs/enums/DolbyDigitalEvolutionFrameworkControl.html +++ b/docs/enums/DolbyDigitalEvolutionFrameworkControl.html @@ -1,4 +1,4 @@ DolbyDigitalEvolutionFrameworkControl | @bitmovin/api-sdk

Enumeration DolbyDigitalEvolutionFrameworkControl

Enable Dolby Evolution Framework control feature

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalLfeLowPassFilter.html b/docs/enums/DolbyDigitalLfeLowPassFilter.html index d36b44a80..2a1ec0f32 100644 --- a/docs/enums/DolbyDigitalLfeLowPassFilter.html +++ b/docs/enums/DolbyDigitalLfeLowPassFilter.html @@ -1,4 +1,4 @@ DolbyDigitalLfeLowPassFilter | @bitmovin/api-sdk

Enumeration DolbyDigitalLfeLowPassFilter

Low frequency effects low pass filter

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalLoudnessControlMode.html b/docs/enums/DolbyDigitalLoudnessControlMode.html index f56f79d15..7e4311b43 100644 --- a/docs/enums/DolbyDigitalLoudnessControlMode.html +++ b/docs/enums/DolbyDigitalLoudnessControlMode.html @@ -1,3 +1,3 @@ -DolbyDigitalLoudnessControlMode | @bitmovin/api-sdk

Enumeration DolbyDigitalLoudnessControlMode

Export

Enumeration Members

CORRECTION +DolbyDigitalLoudnessControlMode | @bitmovin/api-sdk

Enumeration DolbyDigitalLoudnessControlMode

Export

Enumeration Members

CORRECTION PASSTHROUGH -

Enumeration Members

CORRECTION

CORRECTION: "CORRECTION"

PASSTHROUGH

PASSTHROUGH: "PASSTHROUGH"

Settings

Member Visibility

Theme

On This Page

CORRECTIONPASSTHROUGH
\ No newline at end of file +

Enumeration Members

CORRECTION

CORRECTION: "CORRECTION"

PASSTHROUGH

PASSTHROUGH: "PASSTHROUGH"

Settings

Member Visibility

Theme

On This Page

CORRECTIONPASSTHROUGH
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalLoudnessControlRegulationType.html b/docs/enums/DolbyDigitalLoudnessControlRegulationType.html index 15e1dff72..a091a0850 100644 --- a/docs/enums/DolbyDigitalLoudnessControlRegulationType.html +++ b/docs/enums/DolbyDigitalLoudnessControlRegulationType.html @@ -1,5 +1,5 @@ -DolbyDigitalLoudnessControlRegulationType | @bitmovin/api-sdk

Enumeration DolbyDigitalLoudnessControlRegulationType

Export

Enumeration Members

ATSC_A85_AGILE +DolbyDigitalLoudnessControlRegulationType | @bitmovin/api-sdk

Enumeration DolbyDigitalLoudnessControlRegulationType

Export

Enumeration Members

ATSC_A85_AGILE ATSC_A85_FIXED EBU_R128 MANUAL -

Enumeration Members

ATSC_A85_AGILE

ATSC_A85_AGILE: "ATSC_A85_AGILE"

ATSC_A85_FIXED

ATSC_A85_FIXED: "ATSC_A85_FIXED"

EBU_R128

EBU_R128: "EBU_R128"

MANUAL

MANUAL: "MANUAL"

Settings

Member Visibility

Theme

On This Page

ATSC_A85_AGILEATSC_A85_FIXEDEBU_R128MANUAL
\ No newline at end of file +

Enumeration Members

ATSC_A85_AGILE

ATSC_A85_AGILE: "ATSC_A85_AGILE"

ATSC_A85_FIXED

ATSC_A85_FIXED: "ATSC_A85_FIXED"

EBU_R128

EBU_R128: "EBU_R128"

MANUAL

MANUAL: "MANUAL"

Settings

Member Visibility

Theme

On This Page

ATSC_A85_AGILEATSC_A85_FIXEDEBU_R128MANUAL
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalNinetyDegreePhaseShift.html b/docs/enums/DolbyDigitalNinetyDegreePhaseShift.html index ed906bcff..65c8a14fa 100644 --- a/docs/enums/DolbyDigitalNinetyDegreePhaseShift.html +++ b/docs/enums/DolbyDigitalNinetyDegreePhaseShift.html @@ -1,4 +1,4 @@ DolbyDigitalNinetyDegreePhaseShift | @bitmovin/api-sdk

Enumeration DolbyDigitalNinetyDegreePhaseShift

A 90° phase shift can be applied to the surround channels during encoding. This is useful for generating multichannel bitstreams which, when downmixed, can create a true Dolby Surround compatible output (Left/Right)

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusCenterMixLevel.html b/docs/enums/DolbyDigitalPlusCenterMixLevel.html index b788de30f..a137b9af8 100644 --- a/docs/enums/DolbyDigitalPlusCenterMixLevel.html +++ b/docs/enums/DolbyDigitalPlusCenterMixLevel.html @@ -1,4 +1,4 @@ -DolbyDigitalPlusCenterMixLevel | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusCenterMixLevel

Export

Enumeration Members

MINUS_1_5_DB +DolbyDigitalPlusCenterMixLevel | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusCenterMixLevel

Export

Enumeration Members

MINUS_1_5_DB MINUS_3_DB MINUS_4_5_DB MINUS_6_DB @@ -6,4 +6,4 @@ PLUS_1_5_DB PLUS_3_DB ZERO_DB -

Enumeration Members

MINUS_1_5_DB

MINUS_1_5_DB: "MINUS_1_5_DB"

MINUS_3_DB

MINUS_3_DB: "MINUS_3_DB"

MINUS_4_5_DB

MINUS_4_5_DB: "MINUS_4_5_DB"

MINUS_6_DB

MINUS_6_DB: "MINUS_6_DB"

MINUS_INFINITY_DB

MINUS_INFINITY_DB: "MINUS_INFINITY_DB"

PLUS_1_5_DB

PLUS_1_5_DB: "PLUS_1_5_DB"

PLUS_3_DB

PLUS_3_DB: "PLUS_3_DB"

ZERO_DB

ZERO_DB: "ZERO_DB"

Settings

Member Visibility

Theme

On This Page

MINUS_1_5_DBMINUS_3_DBMINUS_4_5_DBMINUS_6_DBMINUS_INFINITY_DBPLUS_1_5_DBPLUS_3_DBZERO_DB
\ No newline at end of file +

Enumeration Members

MINUS_1_5_DB

MINUS_1_5_DB: "MINUS_1_5_DB"

MINUS_3_DB

MINUS_3_DB: "MINUS_3_DB"

MINUS_4_5_DB

MINUS_4_5_DB: "MINUS_4_5_DB"

MINUS_6_DB

MINUS_6_DB: "MINUS_6_DB"

MINUS_INFINITY_DB

MINUS_INFINITY_DB: "MINUS_INFINITY_DB"

PLUS_1_5_DB

PLUS_1_5_DB: "PLUS_1_5_DB"

PLUS_3_DB

PLUS_3_DB: "PLUS_3_DB"

ZERO_DB

ZERO_DB: "ZERO_DB"

Settings

Member Visibility

Theme

On This Page

MINUS_1_5_DBMINUS_3_DBMINUS_4_5_DBMINUS_6_DBMINUS_INFINITY_DBPLUS_1_5_DBPLUS_3_DBZERO_DB
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusChannelLayout.html b/docs/enums/DolbyDigitalPlusChannelLayout.html index 7ee7e6bc5..fecb53a90 100644 --- a/docs/enums/DolbyDigitalPlusChannelLayout.html +++ b/docs/enums/DolbyDigitalPlusChannelLayout.html @@ -1,4 +1,4 @@ -DolbyDigitalPlusChannelLayout | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusChannelLayout

Export

Enumeration Members

CL_3_1 +DolbyDigitalPlusChannelLayout | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusChannelLayout

Export

Enumeration Members

CL_3_1 CL_4_0 CL_4_1 CL_5_0 @@ -11,4 +11,4 @@ CL_SURROUND MONO NONE -

Enumeration Members

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_1

CL_5_1: "5.1"

CL_BACK_SURROUND

CL_BACK_SURROUND: "BACK_SURROUND"

CL_BACK_SURROUND_LFE

CL_BACK_SURROUND_LFE: "BACK_SURROUND_LFE"

CL_QUAD

CL_QUAD: "QUAD"

CL_QUAD_LFE

CL_QUAD_LFE: "QUAD_LFE"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_3_1CL_4_0CL_4_1CL_5_0CL_5_1CL_BACK_SURROUNDCL_BACK_SURROUND_LFECL_QUADCL_QUAD_LFECL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file +

Enumeration Members

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_4_1

CL_4_1: "4.1"

CL_5_0

CL_5_0: "5.0"

CL_5_1

CL_5_1: "5.1"

CL_BACK_SURROUND

CL_BACK_SURROUND: "BACK_SURROUND"

CL_BACK_SURROUND_LFE

CL_BACK_SURROUND_LFE: "BACK_SURROUND_LFE"

CL_QUAD

CL_QUAD: "QUAD"

CL_QUAD_LFE

CL_QUAD_LFE: "QUAD_LFE"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_3_1CL_4_0CL_4_1CL_5_0CL_5_1CL_BACK_SURROUNDCL_BACK_SURROUND_LFECL_QUADCL_QUAD_LFECL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusDialogueIntelligence.html b/docs/enums/DolbyDigitalPlusDialogueIntelligence.html index 86547bd2c..7921cde81 100644 --- a/docs/enums/DolbyDigitalPlusDialogueIntelligence.html +++ b/docs/enums/DolbyDigitalPlusDialogueIntelligence.html @@ -1,4 +1,4 @@ DolbyDigitalPlusDialogueIntelligence | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusDialogueIntelligence

Whether to use the Dolby Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusDownmixingPreferredMode.html b/docs/enums/DolbyDigitalPlusDownmixingPreferredMode.html index 89488ec0d..7e9da6233 100644 --- a/docs/enums/DolbyDigitalPlusDownmixingPreferredMode.html +++ b/docs/enums/DolbyDigitalPlusDownmixingPreferredMode.html @@ -1,5 +1,5 @@ DolbyDigitalPlusDownmixingPreferredMode | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusDownmixingPreferredMode

It indicates if downmixing mode is Dolby Surround compatible (LT_RT: Left total/Right total) or Dolby Pro Logic II (PRO_LOGIC_II). LO_RO for Left only/Right only: A downmix from a multichannel to a two‐channel output that is compatible for stereo or mono reproduction.

-

Export

Enumeration Members

LO_RO +

Export

Enumeration Members

LO_RO LT_RT PRO_LOGIC_II -

Enumeration Members

LO_RO

LO_RO: "LO_RO"

LT_RT

LT_RT: "LT_RT"

PRO_LOGIC_II

PRO_LOGIC_II: "PRO_LOGIC_II"

Settings

Member Visibility

Theme

On This Page

LO_ROLT_RTPRO_LOGIC_II
\ No newline at end of file +

Enumeration Members

LO_RO

LO_RO: "LO_RO"

LT_RT

LT_RT: "LT_RT"

PRO_LOGIC_II

PRO_LOGIC_II: "PRO_LOGIC_II"

Settings

Member Visibility

Theme

On This Page

LO_ROLT_RTPRO_LOGIC_II
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusDynamicRangeCompressionMode.html b/docs/enums/DolbyDigitalPlusDynamicRangeCompressionMode.html index 9f506aacd..358557dbf 100644 --- a/docs/enums/DolbyDigitalPlusDynamicRangeCompressionMode.html +++ b/docs/enums/DolbyDigitalPlusDynamicRangeCompressionMode.html @@ -1,8 +1,8 @@ DolbyDigitalPlusDynamicRangeCompressionMode | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusDynamicRangeCompressionMode

Dynamic range compression processing mode

-

Export

Enumeration Members

FILM_LIGHT +

Export

Enumeration Members

FILM_LIGHT FILM_STANDARD MUSIC_LIGHT MUSIC_STANDARD NONE SPEECH -

Enumeration Members

FILM_LIGHT

FILM_LIGHT: "FILM_LIGHT"

FILM_STANDARD

FILM_STANDARD: "FILM_STANDARD"

MUSIC_LIGHT

MUSIC_LIGHT: "MUSIC_LIGHT"

MUSIC_STANDARD

MUSIC_STANDARD: "MUSIC_STANDARD"

NONE

NONE: "NONE"

SPEECH

SPEECH: "SPEECH"

Settings

Member Visibility

Theme

On This Page

FILM_LIGHTFILM_STANDARDMUSIC_LIGHTMUSIC_STANDARDNONESPEECH
\ No newline at end of file +

Enumeration Members

FILM_LIGHT

FILM_LIGHT: "FILM_LIGHT"

FILM_STANDARD

FILM_STANDARD: "FILM_STANDARD"

MUSIC_LIGHT

MUSIC_LIGHT: "MUSIC_LIGHT"

MUSIC_STANDARD

MUSIC_STANDARD: "MUSIC_STANDARD"

NONE

NONE: "NONE"

SPEECH

SPEECH: "SPEECH"

Settings

Member Visibility

Theme

On This Page

FILM_LIGHTFILM_STANDARDMUSIC_LIGHTMUSIC_STANDARDNONESPEECH
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusEvolutionFrameworkControl.html b/docs/enums/DolbyDigitalPlusEvolutionFrameworkControl.html index 7da15c1b3..eb02bb775 100644 --- a/docs/enums/DolbyDigitalPlusEvolutionFrameworkControl.html +++ b/docs/enums/DolbyDigitalPlusEvolutionFrameworkControl.html @@ -1,4 +1,4 @@ DolbyDigitalPlusEvolutionFrameworkControl | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusEvolutionFrameworkControl

Enable Dolby Evolution Framework control feature

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusLfeLowPassFilter.html b/docs/enums/DolbyDigitalPlusLfeLowPassFilter.html index 58d3af3ca..c21d99de4 100644 --- a/docs/enums/DolbyDigitalPlusLfeLowPassFilter.html +++ b/docs/enums/DolbyDigitalPlusLfeLowPassFilter.html @@ -1,4 +1,4 @@ DolbyDigitalPlusLfeLowPassFilter | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusLfeLowPassFilter

Low frequency effects low pass filter

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusLoudnessControlMode.html b/docs/enums/DolbyDigitalPlusLoudnessControlMode.html index c56632f89..be4a84cef 100644 --- a/docs/enums/DolbyDigitalPlusLoudnessControlMode.html +++ b/docs/enums/DolbyDigitalPlusLoudnessControlMode.html @@ -1,3 +1,3 @@ -DolbyDigitalPlusLoudnessControlMode | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusLoudnessControlMode

Export

Enumeration Members

CORRECTION +DolbyDigitalPlusLoudnessControlMode | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusLoudnessControlMode

Export

Enumeration Members

CORRECTION PASSTHROUGH -

Enumeration Members

CORRECTION

CORRECTION: "CORRECTION"

PASSTHROUGH

PASSTHROUGH: "PASSTHROUGH"

Settings

Member Visibility

Theme

On This Page

CORRECTIONPASSTHROUGH
\ No newline at end of file +

Enumeration Members

CORRECTION

CORRECTION: "CORRECTION"

PASSTHROUGH

PASSTHROUGH: "PASSTHROUGH"

Settings

Member Visibility

Theme

On This Page

CORRECTIONPASSTHROUGH
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusLoudnessControlRegulationType.html b/docs/enums/DolbyDigitalPlusLoudnessControlRegulationType.html index 4bb68cf69..16aed9c9f 100644 --- a/docs/enums/DolbyDigitalPlusLoudnessControlRegulationType.html +++ b/docs/enums/DolbyDigitalPlusLoudnessControlRegulationType.html @@ -1,5 +1,5 @@ -DolbyDigitalPlusLoudnessControlRegulationType | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusLoudnessControlRegulationType

Export

Enumeration Members

ATSC_A85_AGILE +DolbyDigitalPlusLoudnessControlRegulationType | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusLoudnessControlRegulationType

Export

Enumeration Members

ATSC_A85_AGILE ATSC_A85_FIXED EBU_R128 MANUAL -

Enumeration Members

ATSC_A85_AGILE

ATSC_A85_AGILE: "ATSC_A85_AGILE"

ATSC_A85_FIXED

ATSC_A85_FIXED: "ATSC_A85_FIXED"

EBU_R128

EBU_R128: "EBU_R128"

MANUAL

MANUAL: "MANUAL"

Settings

Member Visibility

Theme

On This Page

ATSC_A85_AGILEATSC_A85_FIXEDEBU_R128MANUAL
\ No newline at end of file +

Enumeration Members

ATSC_A85_AGILE

ATSC_A85_AGILE: "ATSC_A85_AGILE"

ATSC_A85_FIXED

ATSC_A85_FIXED: "ATSC_A85_FIXED"

EBU_R128

EBU_R128: "EBU_R128"

MANUAL

MANUAL: "MANUAL"

Settings

Member Visibility

Theme

On This Page

ATSC_A85_AGILEATSC_A85_FIXEDEBU_R128MANUAL
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusNinetyDegreePhaseShift.html b/docs/enums/DolbyDigitalPlusNinetyDegreePhaseShift.html index b2c5d45d1..4f230e765 100644 --- a/docs/enums/DolbyDigitalPlusNinetyDegreePhaseShift.html +++ b/docs/enums/DolbyDigitalPlusNinetyDegreePhaseShift.html @@ -1,4 +1,4 @@ DolbyDigitalPlusNinetyDegreePhaseShift | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusNinetyDegreePhaseShift

A 90° phase shift can be applied to the surround channels during encoding. This is useful for generating multichannel bitstreams which, when downmixed, can create a true Dolby Surround compatible output (Left/Right)

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusSurroundMixLevel.html b/docs/enums/DolbyDigitalPlusSurroundMixLevel.html index afd7ac735..afc729ce8 100644 --- a/docs/enums/DolbyDigitalPlusSurroundMixLevel.html +++ b/docs/enums/DolbyDigitalPlusSurroundMixLevel.html @@ -1,6 +1,6 @@ -DolbyDigitalPlusSurroundMixLevel | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusSurroundMixLevel

Export

Enumeration Members

MINUS_1_5_DB +DolbyDigitalPlusSurroundMixLevel | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusSurroundMixLevel

Export

Enumeration Members

MINUS_1_5_DB MINUS_3_DB MINUS_4_5_DB MINUS_6_DB MINUS_INFINITY_DB -

Enumeration Members

MINUS_1_5_DB

MINUS_1_5_DB: "MINUS_1_5_DB"

MINUS_3_DB

MINUS_3_DB: "MINUS_3_DB"

MINUS_4_5_DB

MINUS_4_5_DB: "MINUS_4_5_DB"

MINUS_6_DB

MINUS_6_DB: "MINUS_6_DB"

MINUS_INFINITY_DB

MINUS_INFINITY_DB: "MINUS_INFINITY_DB"

Settings

Member Visibility

Theme

On This Page

MINUS_1_5_DBMINUS_3_DBMINUS_4_5_DBMINUS_6_DBMINUS_INFINITY_DB
\ No newline at end of file +

Enumeration Members

MINUS_1_5_DB

MINUS_1_5_DB: "MINUS_1_5_DB"

MINUS_3_DB

MINUS_3_DB: "MINUS_3_DB"

MINUS_4_5_DB

MINUS_4_5_DB: "MINUS_4_5_DB"

MINUS_6_DB

MINUS_6_DB: "MINUS_6_DB"

MINUS_INFINITY_DB

MINUS_INFINITY_DB: "MINUS_INFINITY_DB"

Settings

Member Visibility

Theme

On This Page

MINUS_1_5_DBMINUS_3_DBMINUS_4_5_DBMINUS_6_DBMINUS_INFINITY_DB
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusSurroundMode.html b/docs/enums/DolbyDigitalPlusSurroundMode.html index 513c7bad7..492cbc3b6 100644 --- a/docs/enums/DolbyDigitalPlusSurroundMode.html +++ b/docs/enums/DolbyDigitalPlusSurroundMode.html @@ -1,4 +1,4 @@ -DolbyDigitalPlusSurroundMode | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusSurroundMode

Export

Enumeration Members

DISABLED +DolbyDigitalPlusSurroundMode | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusSurroundMode

Export

Enumeration Members

DISABLED ENABLED NOT_INDICATED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

NOT_INDICATED

NOT_INDICATED: "NOT_INDICATED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLEDNOT_INDICATED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

NOT_INDICATED

NOT_INDICATED: "NOT_INDICATED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLEDNOT_INDICATED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalPlusThreeDbAttenuation.html b/docs/enums/DolbyDigitalPlusThreeDbAttenuation.html index 44c940895..644ee4fd7 100644 --- a/docs/enums/DolbyDigitalPlusThreeDbAttenuation.html +++ b/docs/enums/DolbyDigitalPlusThreeDbAttenuation.html @@ -1,4 +1,4 @@ DolbyDigitalPlusThreeDbAttenuation | @bitmovin/api-sdk

Enumeration DolbyDigitalPlusThreeDbAttenuation

–3 dB attenuation can be used to reduce the levels of the surround channels to compensate between the calibration of film dubbing stages and consumer replay environments. The surround channels in film studios are set 3 dB lower than the front channels (unlike consumer applications of 5.1), leading to the level on tape being 3 dB higher. Apply the 3 dB attenuation when using a master mixed in a film room.

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalSurroundMixLevel.html b/docs/enums/DolbyDigitalSurroundMixLevel.html index 0b9d311f9..09403ca2c 100644 --- a/docs/enums/DolbyDigitalSurroundMixLevel.html +++ b/docs/enums/DolbyDigitalSurroundMixLevel.html @@ -1,6 +1,6 @@ -DolbyDigitalSurroundMixLevel | @bitmovin/api-sdk

Enumeration DolbyDigitalSurroundMixLevel

Export

Enumeration Members

MINUS_1_5_DB +DolbyDigitalSurroundMixLevel | @bitmovin/api-sdk

Enumeration DolbyDigitalSurroundMixLevel

Export

Enumeration Members

MINUS_1_5_DB MINUS_3_DB MINUS_4_5_DB MINUS_6_DB MINUS_INFINITY_DB -

Enumeration Members

MINUS_1_5_DB

MINUS_1_5_DB: "MINUS_1_5_DB"

MINUS_3_DB

MINUS_3_DB: "MINUS_3_DB"

MINUS_4_5_DB

MINUS_4_5_DB: "MINUS_4_5_DB"

MINUS_6_DB

MINUS_6_DB: "MINUS_6_DB"

MINUS_INFINITY_DB

MINUS_INFINITY_DB: "MINUS_INFINITY_DB"

Settings

Member Visibility

Theme

On This Page

MINUS_1_5_DBMINUS_3_DBMINUS_4_5_DBMINUS_6_DBMINUS_INFINITY_DB
\ No newline at end of file +

Enumeration Members

MINUS_1_5_DB

MINUS_1_5_DB: "MINUS_1_5_DB"

MINUS_3_DB

MINUS_3_DB: "MINUS_3_DB"

MINUS_4_5_DB

MINUS_4_5_DB: "MINUS_4_5_DB"

MINUS_6_DB

MINUS_6_DB: "MINUS_6_DB"

MINUS_INFINITY_DB

MINUS_INFINITY_DB: "MINUS_INFINITY_DB"

Settings

Member Visibility

Theme

On This Page

MINUS_1_5_DBMINUS_3_DBMINUS_4_5_DBMINUS_6_DBMINUS_INFINITY_DB
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalSurroundMode.html b/docs/enums/DolbyDigitalSurroundMode.html index 58c728caf..a6e341998 100644 --- a/docs/enums/DolbyDigitalSurroundMode.html +++ b/docs/enums/DolbyDigitalSurroundMode.html @@ -1,4 +1,4 @@ -DolbyDigitalSurroundMode | @bitmovin/api-sdk

Enumeration DolbyDigitalSurroundMode

Export

Enumeration Members

DISABLED +DolbyDigitalSurroundMode | @bitmovin/api-sdk

Enumeration DolbyDigitalSurroundMode

Export

Enumeration Members

DISABLED ENABLED NOT_INDICATED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

NOT_INDICATED

NOT_INDICATED: "NOT_INDICATED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLEDNOT_INDICATED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

NOT_INDICATED

NOT_INDICATED: "NOT_INDICATED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLEDNOT_INDICATED
\ No newline at end of file diff --git a/docs/enums/DolbyDigitalThreeDbAttenuation.html b/docs/enums/DolbyDigitalThreeDbAttenuation.html index 20e89e2be..d48b68e15 100644 --- a/docs/enums/DolbyDigitalThreeDbAttenuation.html +++ b/docs/enums/DolbyDigitalThreeDbAttenuation.html @@ -1,4 +1,4 @@ DolbyDigitalThreeDbAttenuation | @bitmovin/api-sdk

Enumeration DolbyDigitalThreeDbAttenuation

–3 dB attenuation can be used to reduce the levels of the surround channels to compensate between the calibration of film dubbing stages and consumer replay environments. The surround channels in film studios are set 3 dB lower than the front channels (unlike consumer applications of 5.1), leading to the level on tape being 3 dB higher. Apply the 3 dB attenuation when using a master mixed in a film room.

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyVisionMetadataSource.html b/docs/enums/DolbyVisionMetadataSource.html index bbf6c1af2..3e0a954fe 100644 --- a/docs/enums/DolbyVisionMetadataSource.html +++ b/docs/enums/DolbyVisionMetadataSource.html @@ -1,3 +1,3 @@ -DolbyVisionMetadataSource | @bitmovin/api-sdk

Enumeration DolbyVisionMetadataSource

Export

Enumeration Members

EMBEDDED +DolbyVisionMetadataSource | @bitmovin/api-sdk

Enumeration DolbyVisionMetadataSource

Export

Enumeration Members

EMBEDDED INPUT_STREAM -

Enumeration Members

EMBEDDED

EMBEDDED: "EMBEDDED"

INPUT_STREAM

INPUT_STREAM: "INPUT_STREAM"

Settings

Member Visibility

Theme

On This Page

EMBEDDEDINPUT_STREAM
\ No newline at end of file +

Enumeration Members

EMBEDDED

EMBEDDED: "EMBEDDED"

INPUT_STREAM

INPUT_STREAM: "INPUT_STREAM"

Settings

Member Visibility

Theme

On This Page

EMBEDDEDINPUT_STREAM
\ No newline at end of file diff --git a/docs/enums/DolbyVisionPerStreamMode.html b/docs/enums/DolbyVisionPerStreamMode.html index a31152bf2..72f92d1e9 100644 --- a/docs/enums/DolbyVisionPerStreamMode.html +++ b/docs/enums/DolbyVisionPerStreamMode.html @@ -1,3 +1,3 @@ -DolbyVisionPerStreamMode | @bitmovin/api-sdk

Enumeration DolbyVisionPerStreamMode

Export

Enumeration Members

DISABLED +DolbyVisionPerStreamMode | @bitmovin/api-sdk

Enumeration DolbyVisionPerStreamMode

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/DolbyVisionProfile.html b/docs/enums/DolbyVisionProfile.html index e76c7f590..175eb0803 100644 --- a/docs/enums/DolbyVisionProfile.html +++ b/docs/enums/DolbyVisionProfile.html @@ -1,6 +1,6 @@ -DolbyVisionProfile | @bitmovin/api-sdk

Enumeration DolbyVisionProfile

Export

Enumeration Members

AVC3_09 +DolbyVisionProfile | @bitmovin/api-sdk

Enumeration DolbyVisionProfile

Export

Enumeration Members

AVC3_09 DVHE_04 DVHE_05 DVHE_07 HEV1_08 -

Enumeration Members

AVC3_09

AVC3_09: "AVC3_09"

DVHE_04

DVHE_04: "DVHE_04"

DVHE_05

DVHE_05: "DVHE_05"

DVHE_07

DVHE_07: "DVHE_07"

HEV1_08

HEV1_08: "HEV1_08"

Settings

Member Visibility

Theme

On This Page

AVC3_09DVHE_04DVHE_05DVHE_07HEV1_08
\ No newline at end of file +

Enumeration Members

AVC3_09

AVC3_09: "AVC3_09"

DVHE_04

DVHE_04: "DVHE_04"

DVHE_05

DVHE_05: "DVHE_05"

DVHE_07

DVHE_07: "DVHE_07"

HEV1_08

HEV1_08: "HEV1_08"

Settings

Member Visibility

Theme

On This Page

AVC3_09DVHE_04DVHE_05DVHE_07HEV1_08
\ No newline at end of file diff --git a/docs/enums/DolbyVisionTrackSampleEntryName.html b/docs/enums/DolbyVisionTrackSampleEntryName.html index 1bf4067cf..7969ca0b6 100644 --- a/docs/enums/DolbyVisionTrackSampleEntryName.html +++ b/docs/enums/DolbyVisionTrackSampleEntryName.html @@ -1,4 +1,4 @@ DolbyVisionTrackSampleEntryName | @bitmovin/api-sdk

Enumeration DolbyVisionTrackSampleEntryName

Dolby Vision track's sample entry name

-

Export

Enumeration Members

DVH1 +

Export

Enumeration Members

DVH1 DVHE -

Enumeration Members

DVH1

DVH1: "DVH1"

DVHE

DVHE: "DVHE"

Settings

Member Visibility

Theme

On This Page

DVH1DVHE
\ No newline at end of file +

Enumeration Members

DVH1

DVH1: "DVH1"

DVHE

DVHE: "DVHE"

Settings

Member Visibility

Theme

On This Page

DVH1DVHE
\ No newline at end of file diff --git a/docs/enums/DrmType.html b/docs/enums/DrmType.html index ae5058a72..e995571e0 100644 --- a/docs/enums/DrmType.html +++ b/docs/enums/DrmType.html @@ -1,5 +1,5 @@ DrmType | @bitmovin/api-sdk

Enumeration DrmType

The type of the drm

-

Export

Enumeration Members

AES +

Export

Enumeration Members

AES CENC CLEARKEY FAIRPLAY @@ -8,4 +8,4 @@ PRIMETIME SPEKE WIDEVINE -

Enumeration Members

AES

AES: "AES"

CENC

CENC: "CENC"

CLEARKEY

CLEARKEY: "CLEARKEY"

FAIRPLAY

FAIRPLAY: "FAIRPLAY"

MARLIN

MARLIN: "MARLIN"

PLAYREADY

PLAYREADY: "PLAYREADY"

PRIMETIME

PRIMETIME: "PRIMETIME"

SPEKE

SPEKE: "SPEKE"

WIDEVINE

WIDEVINE: "WIDEVINE"

Settings

Member Visibility

Theme

On This Page

AESCENCCLEARKEYFAIRPLAYMARLINPLAYREADYPRIMETIMESPEKEWIDEVINE
\ No newline at end of file +

Enumeration Members

AES

AES: "AES"

CENC

CENC: "CENC"

CLEARKEY

CLEARKEY: "CLEARKEY"

FAIRPLAY

FAIRPLAY: "FAIRPLAY"

MARLIN

MARLIN: "MARLIN"

PLAYREADY

PLAYREADY: "PLAYREADY"

PRIMETIME

PRIMETIME: "PRIMETIME"

SPEKE

SPEKE: "SPEKE"

WIDEVINE

WIDEVINE: "WIDEVINE"

Settings

Member Visibility

Theme

On This Page

AESCENCCLEARKEYFAIRPLAYMARLINPLAYREADYPRIMETIMESPEKEWIDEVINE
\ No newline at end of file diff --git a/docs/enums/DtsMode.html b/docs/enums/DtsMode.html index 86d4129cd..adf74379d 100644 --- a/docs/enums/DtsMode.html +++ b/docs/enums/DtsMode.html @@ -1,3 +1,3 @@ -DtsMode | @bitmovin/api-sdk

Enumeration DtsMode

Export

Enumeration Members

DIGITAL_SURROUND +DtsMode | @bitmovin/api-sdk

Enumeration DtsMode

Export

Enumeration Members

DIGITAL_SURROUND EXPRESS_AUDIO -

Enumeration Members

DIGITAL_SURROUND

DIGITAL_SURROUND: "DIGITAL_SURROUND"

EXPRESS_AUDIO

EXPRESS_AUDIO: "EXPRESS_AUDIO"

Settings

Member Visibility

Theme

On This Page

DIGITAL_SURROUNDEXPRESS_AUDIO
\ No newline at end of file +

Enumeration Members

DIGITAL_SURROUND

DIGITAL_SURROUND: "DIGITAL_SURROUND"

EXPRESS_AUDIO

EXPRESS_AUDIO: "EXPRESS_AUDIO"

Settings

Member Visibility

Theme

On This Page

DIGITAL_SURROUNDEXPRESS_AUDIO
\ No newline at end of file diff --git a/docs/enums/DtsXChannelLayout.html b/docs/enums/DtsXChannelLayout.html index cb9d4f761..e2fbfa899 100644 --- a/docs/enums/DtsXChannelLayout.html +++ b/docs/enums/DtsXChannelLayout.html @@ -1,4 +1,4 @@ DtsXChannelLayout | @bitmovin/api-sdk

Enumeration DtsXChannelLayout

Can be 5.1 or 5.1.4

-

Export

Enumeration Members

CL_5_1 +

Export

Enumeration Members

CL_5_1 CL_5_1_4 -

Enumeration Members

CL_5_1

CL_5_1: "5.1"

CL_5_1_4

CL_5_1_4: "5.1.4"

Settings

Member Visibility

Theme

On This Page

CL_5_1CL_5_1_4
\ No newline at end of file +

Enumeration Members

CL_5_1

CL_5_1: "5.1"

CL_5_1_4

CL_5_1_4: "5.1.4"

Settings

Member Visibility

Theme

On This Page

CL_5_1CL_5_1_4
\ No newline at end of file diff --git a/docs/enums/EgressCategory.html b/docs/enums/EgressCategory.html index a3836ddb0..8e265e465 100644 --- a/docs/enums/EgressCategory.html +++ b/docs/enums/EgressCategory.html @@ -1,3 +1,3 @@ -EgressCategory | @bitmovin/api-sdk

Enumeration EgressCategory

Export

Enumeration Members

TRANSFER +EgressCategory | @bitmovin/api-sdk

Enumeration EgressCategory

Export

Enumeration Members

TRANSFER TRANSFER_RETRY -

Enumeration Members

TRANSFER

TRANSFER: "TRANSFER"

TRANSFER_RETRY

TRANSFER_RETRY: "TRANSFER_RETRY"

Settings

Member Visibility

Theme

On This Page

TRANSFERTRANSFER_RETRY
\ No newline at end of file +

Enumeration Members

TRANSFER

TRANSFER: "TRANSFER"

TRANSFER_RETRY

TRANSFER_RETRY: "TRANSFER_RETRY"

Settings

Member Visibility

Theme

On This Page

TRANSFERTRANSFER_RETRY
\ No newline at end of file diff --git a/docs/enums/EncodingMode.html b/docs/enums/EncodingMode.html index 22b18c850..3bfce5ddc 100644 --- a/docs/enums/EncodingMode.html +++ b/docs/enums/EncodingMode.html @@ -1,5 +1,5 @@ -EncodingMode | @bitmovin/api-sdk

Enumeration EncodingMode

Export

Enumeration Members

SINGLE_PASS +EncodingMode | @bitmovin/api-sdk

Enumeration EncodingMode

Export

Enumeration Members

SINGLE_PASS STANDARD THREE_PASS TWO_PASS -

Enumeration Members

SINGLE_PASS

SINGLE_PASS: "SINGLE_PASS"

STANDARD

STANDARD: "STANDARD"

THREE_PASS

THREE_PASS: "THREE_PASS"

TWO_PASS

TWO_PASS: "TWO_PASS"

Settings

Member Visibility

Theme

On This Page

SINGLE_PASSSTANDARDTHREE_PASSTWO_PASS
\ No newline at end of file +

Enumeration Members

SINGLE_PASS

SINGLE_PASS: "SINGLE_PASS"

STANDARD

STANDARD: "STANDARD"

THREE_PASS

THREE_PASS: "THREE_PASS"

TWO_PASS

TWO_PASS: "TWO_PASS"

Settings

Member Visibility

Theme

On This Page

SINGLE_PASSSTANDARDTHREE_PASSTWO_PASS
\ No newline at end of file diff --git a/docs/enums/EncodingTemplate.html b/docs/enums/EncodingTemplate.html index 1d5019253..a6e354c9b 100644 --- a/docs/enums/EncodingTemplate.html +++ b/docs/enums/EncodingTemplate.html @@ -1,4 +1,4 @@ -EncodingTemplate | @bitmovin/api-sdk

Enumeration EncodingTemplate

Export

Enumeration Members

AV1 +EncodingTemplate | @bitmovin/api-sdk

Enumeration EncodingTemplate

Export

Enumeration Members

AV1 H264 H264_FIXED_RESOLUTIONS -

Enumeration Members

AV1

AV1: "AV1"

H264

H264: "H264"

H264_FIXED_RESOLUTIONS

H264_FIXED_RESOLUTIONS: "H264_FIXED_RESOLUTIONS"

Settings

Member Visibility

Theme

On This Page

AV1H264H264_FIXED_RESOLUTIONS
\ No newline at end of file +

Enumeration Members

AV1

AV1: "AV1"

H264

H264: "H264"

H264_FIXED_RESOLUTIONS

H264_FIXED_RESOLUTIONS: "H264_FIXED_RESOLUTIONS"

Settings

Member Visibility

Theme

On This Page

AV1H264H264_FIXED_RESOLUTIONS
\ No newline at end of file diff --git a/docs/enums/EncodingType.html b/docs/enums/EncodingType.html index c97a7046b..3605b1df3 100644 --- a/docs/enums/EncodingType.html +++ b/docs/enums/EncodingType.html @@ -1,4 +1,4 @@ -EncodingType | @bitmovin/api-sdk

Enumeration EncodingType

Export

Enumeration Members

LIVE +EncodingType | @bitmovin/api-sdk

Enumeration EncodingType

Export

Enumeration Members

LIVE NONE VOD -

Enumeration Members

LIVE

LIVE: "LIVE"

NONE

NONE: "NONE"

VOD

VOD: "VOD"

Settings

Member Visibility

Theme

On This Page

LIVENONEVOD
\ No newline at end of file +

Enumeration Members

LIVE

LIVE: "LIVE"

NONE

NONE: "NONE"

VOD

VOD: "VOD"

Settings

Member Visibility

Theme

On This Page

LIVENONEVOD
\ No newline at end of file diff --git a/docs/enums/EncryptionMode.html b/docs/enums/EncryptionMode.html index 59a3b8ced..692099c90 100644 --- a/docs/enums/EncryptionMode.html +++ b/docs/enums/EncryptionMode.html @@ -1,4 +1,4 @@ EncryptionMode | @bitmovin/api-sdk

Enumeration EncryptionMode

The encryption method to use.

-

Export

Enumeration Members

CBC +

Export

Enumeration Members

CBC CTR -

Enumeration Members

CBC

CBC: "CBC"

CTR

CTR: "CTR"

Settings

Member Visibility

Theme

On This Page

CBCCTR
\ No newline at end of file +

Enumeration Members

CBC

CBC: "CBC"

CTR

CTR: "CTR"

Settings

Member Visibility

Theme

On This Page

CBCCTR
\ No newline at end of file diff --git a/docs/enums/EnhancedDeinterlaceAutoEnable.html b/docs/enums/EnhancedDeinterlaceAutoEnable.html index 5a16fb1cc..b8c43e30e 100644 --- a/docs/enums/EnhancedDeinterlaceAutoEnable.html +++ b/docs/enums/EnhancedDeinterlaceAutoEnable.html @@ -1,4 +1,4 @@ EnhancedDeinterlaceAutoEnable | @bitmovin/api-sdk

Enumeration EnhancedDeinterlaceAutoEnable

Specifies if the Enhanced Deinterlace Filter should be applied unconditionally or only on demand.

-

Export

Enumeration Members

ALWAYS_ON +

Export

Enumeration Members

ALWAYS_ON META_DATA_BASED -

Enumeration Members

ALWAYS_ON

ALWAYS_ON: "ALWAYS_ON"

META_DATA_BASED

META_DATA_BASED: "META_DATA_BASED"

Settings

Member Visibility

Theme

On This Page

ALWAYS_ONMETA_DATA_BASED
\ No newline at end of file +

Enumeration Members

ALWAYS_ON

ALWAYS_ON: "ALWAYS_ON"

META_DATA_BASED

META_DATA_BASED: "META_DATA_BASED"

Settings

Member Visibility

Theme

On This Page

ALWAYS_ONMETA_DATA_BASED
\ No newline at end of file diff --git a/docs/enums/EnhancedDeinterlaceMode.html b/docs/enums/EnhancedDeinterlaceMode.html index c8df2e843..727457691 100644 --- a/docs/enums/EnhancedDeinterlaceMode.html +++ b/docs/enums/EnhancedDeinterlaceMode.html @@ -1,4 +1,4 @@ EnhancedDeinterlaceMode | @bitmovin/api-sdk

Enumeration EnhancedDeinterlaceMode

Specifies the method how fields are converted to frames

-

Export

Enumeration Members

FIELD +

Export

Enumeration Members

FIELD FRAME -

Enumeration Members

FIELD

FIELD: "FIELD"

FRAME

FRAME: "FRAME"

Settings

Member Visibility

Theme

On This Page

FIELDFRAME
\ No newline at end of file +

Enumeration Members

FIELD

FIELD: "FIELD"

FRAME

FRAME: "FRAME"

Settings

Member Visibility

Theme

On This Page

FIELDFRAME
\ No newline at end of file diff --git a/docs/enums/EnhancedDeinterlaceParity.html b/docs/enums/EnhancedDeinterlaceParity.html index f77cf5c7b..187ec6467 100644 --- a/docs/enums/EnhancedDeinterlaceParity.html +++ b/docs/enums/EnhancedDeinterlaceParity.html @@ -1,4 +1,4 @@ EnhancedDeinterlaceParity | @bitmovin/api-sdk

Enumeration EnhancedDeinterlaceParity

Specifies which field of an interlaced frame is assumed to be the first one

-

Export

Enumeration Members

BOTTOM_FIELD_FIRST +

Export

Enumeration Members

BOTTOM_FIELD_FIRST TOP_FIELD_FIRST -

Enumeration Members

BOTTOM_FIELD_FIRST

BOTTOM_FIELD_FIRST: "BOTTOM_FIELD_FIRST"

TOP_FIELD_FIRST

TOP_FIELD_FIRST: "TOP_FIELD_FIRST"

Settings

Member Visibility

Theme

On This Page

BOTTOM_FIELD_FIRSTTOP_FIELD_FIRST
\ No newline at end of file +

Enumeration Members

BOTTOM_FIELD_FIRST

BOTTOM_FIELD_FIRST: "BOTTOM_FIELD_FIRST"

TOP_FIELD_FIRST

TOP_FIELD_FIRST: "TOP_FIELD_FIRST"

Settings

Member Visibility

Theme

On This Page

BOTTOM_FIELD_FIRSTTOP_FIELD_FIRST
\ No newline at end of file diff --git a/docs/enums/ErrorRetryHint.html b/docs/enums/ErrorRetryHint.html index 299d3359c..bcc05171d 100644 --- a/docs/enums/ErrorRetryHint.html +++ b/docs/enums/ErrorRetryHint.html @@ -1,4 +1,4 @@ -ErrorRetryHint | @bitmovin/api-sdk

Enumeration ErrorRetryHint

Export

Enumeration Members

NO_RETRY +ErrorRetryHint | @bitmovin/api-sdk

Enumeration ErrorRetryHint

Export

Enumeration Members

NO_RETRY RETRY RETRY_IN_DIFFERENT_REGION -

Enumeration Members

NO_RETRY

NO_RETRY: "NO_RETRY"

RETRY

RETRY: "RETRY"

RETRY_IN_DIFFERENT_REGION

RETRY_IN_DIFFERENT_REGION: "RETRY_IN_DIFFERENT_REGION"

Settings

Member Visibility

Theme

On This Page

NO_RETRYRETRYRETRY_IN_DIFFERENT_REGION
\ No newline at end of file +

Enumeration Members

NO_RETRY

NO_RETRY: "NO_RETRY"

RETRY

RETRY: "RETRY"

RETRY_IN_DIFFERENT_REGION

RETRY_IN_DIFFERENT_REGION: "RETRY_IN_DIFFERENT_REGION"

Settings

Member Visibility

Theme

On This Page

NO_RETRYRETRYRETRY_IN_DIFFERENT_REGION
\ No newline at end of file diff --git a/docs/enums/ExternalIdMode.html b/docs/enums/ExternalIdMode.html index 98b2154dd..fe9458ed9 100644 --- a/docs/enums/ExternalIdMode.html +++ b/docs/enums/ExternalIdMode.html @@ -1,4 +1,4 @@ -ExternalIdMode | @bitmovin/api-sdk

Enumeration ExternalIdMode

Export

Enumeration Members

CUSTOM +ExternalIdMode | @bitmovin/api-sdk

Enumeration ExternalIdMode

Export

Enumeration Members

CUSTOM GENERATED GLOBAL -

Enumeration Members

CUSTOM

CUSTOM: "CUSTOM"

GENERATED

GENERATED: "GENERATED"

GLOBAL

GLOBAL: "GLOBAL"

Settings

Member Visibility

Theme

On This Page

CUSTOMGENERATEDGLOBAL
\ No newline at end of file +

Enumeration Members

CUSTOM

CUSTOM: "CUSTOM"

GENERATED

GENERATED: "GENERATED"

GLOBAL

GLOBAL: "GLOBAL"

Settings

Member Visibility

Theme

On This Page

CUSTOMGENERATEDGLOBAL
\ No newline at end of file diff --git a/docs/enums/FileInputStreamType.html b/docs/enums/FileInputStreamType.html index 2c54e824f..8fad0eae3 100644 --- a/docs/enums/FileInputStreamType.html +++ b/docs/enums/FileInputStreamType.html @@ -1,4 +1,4 @@ -FileInputStreamType | @bitmovin/api-sdk

Enumeration FileInputStreamType

Export

Enumeration Members

SRT +FileInputStreamType | @bitmovin/api-sdk

Enumeration FileInputStreamType

Export

Enumeration Members

SRT TTML WEBVTT -

Enumeration Members

SRT

SRT: "SRT"

TTML

TTML: "TTML"

WEBVTT

WEBVTT: "WEBVTT"

Settings

Member Visibility

Theme

On This Page

SRTTTMLWEBVTT
\ No newline at end of file +

Enumeration Members

SRT

SRT: "SRT"

TTML

TTML: "TTML"

WEBVTT

WEBVTT: "WEBVTT"

Settings

Member Visibility

Theme

On This Page

SRTTTMLWEBVTT
\ No newline at end of file diff --git a/docs/enums/FilterType.html b/docs/enums/FilterType.html index 547f3d925..7d3f49606 100644 --- a/docs/enums/FilterType.html +++ b/docs/enums/FilterType.html @@ -1,4 +1,4 @@ -FilterType | @bitmovin/api-sdk

Enumeration FilterType

Export

Enumeration Members

AUDIO_MIX +FilterType | @bitmovin/api-sdk

Enumeration FilterType

Export

Enumeration Members

AUDIO_MIX AUDIO_VOLUME AZURE_SPEECH_TO_CAPTIONS CONFORM @@ -14,4 +14,4 @@ TEXT UNSHARP WATERMARK -

Enumeration Members

AUDIO_MIX

AUDIO_MIX: "AUDIO_MIX"

AUDIO_VOLUME

AUDIO_VOLUME: "AUDIO_VOLUME"

AZURE_SPEECH_TO_CAPTIONS

AZURE_SPEECH_TO_CAPTIONS: "AZURE_SPEECH_TO_CAPTIONS"

CONFORM

CONFORM: "CONFORM"

CROP

CROP: "CROP"

DEINTERLACE

DEINTERLACE: "DEINTERLACE"

DENOISE_HQDN3D

DENOISE_HQDN3D: "DENOISE_HQDN3D"

EBU_R128_SINGLE_PASS

EBU_R128_SINGLE_PASS: "EBU_R128_SINGLE_PASS"

ENHANCED_DEINTERLACE

ENHANCED_DEINTERLACE: "ENHANCED_DEINTERLACE"

ENHANCED_WATERMARK

ENHANCED_WATERMARK: "ENHANCED_WATERMARK"

INTERLACE

INTERLACE: "INTERLACE"

ROTATE

ROTATE: "ROTATE"

SCALE

SCALE: "SCALE"

TEXT

TEXT: "TEXT"

UNSHARP

UNSHARP: "UNSHARP"

WATERMARK

WATERMARK: "WATERMARK"

Settings

Member Visibility

Theme

On This Page

AUDIO_MIXAUDIO_VOLUMEAZURE_SPEECH_TO_CAPTIONSCONFORMCROPDEINTERLACEDENOISE_HQDN3DEBU_R128_SINGLE_PASSENHANCED_DEINTERLACEENHANCED_WATERMARKINTERLACEROTATESCALETEXTUNSHARPWATERMARK
\ No newline at end of file +

Enumeration Members

AUDIO_MIX

AUDIO_MIX: "AUDIO_MIX"

AUDIO_VOLUME

AUDIO_VOLUME: "AUDIO_VOLUME"

AZURE_SPEECH_TO_CAPTIONS

AZURE_SPEECH_TO_CAPTIONS: "AZURE_SPEECH_TO_CAPTIONS"

CONFORM

CONFORM: "CONFORM"

CROP

CROP: "CROP"

DEINTERLACE

DEINTERLACE: "DEINTERLACE"

DENOISE_HQDN3D

DENOISE_HQDN3D: "DENOISE_HQDN3D"

EBU_R128_SINGLE_PASS

EBU_R128_SINGLE_PASS: "EBU_R128_SINGLE_PASS"

ENHANCED_DEINTERLACE

ENHANCED_DEINTERLACE: "ENHANCED_DEINTERLACE"

ENHANCED_WATERMARK

ENHANCED_WATERMARK: "ENHANCED_WATERMARK"

INTERLACE

INTERLACE: "INTERLACE"

ROTATE

ROTATE: "ROTATE"

SCALE

SCALE: "SCALE"

TEXT

TEXT: "TEXT"

UNSHARP

UNSHARP: "UNSHARP"

WATERMARK

WATERMARK: "WATERMARK"

Settings

Member Visibility

Theme

On This Page

AUDIO_MIXAUDIO_VOLUMEAZURE_SPEECH_TO_CAPTIONSCONFORMCROPDEINTERLACEDENOISE_HQDN3DEBU_R128_SINGLE_PASSENHANCED_DEINTERLACEENHANCED_WATERMARKINTERLACEROTATESCALETEXTUNSHARPWATERMARK
\ No newline at end of file diff --git a/docs/enums/ForceFlushMode.html b/docs/enums/ForceFlushMode.html index ee12eaa77..22fc746b7 100644 --- a/docs/enums/ForceFlushMode.html +++ b/docs/enums/ForceFlushMode.html @@ -1,5 +1,5 @@ ForceFlushMode | @bitmovin/api-sdk

Enumeration ForceFlushMode

Force the encoder to flush frames. Default is DISABLED.

-

Export

Enumeration Members

ALL_FRAMES +

Export

Enumeration Members

ALL_FRAMES DISABLED SLICE_TYPE -

Enumeration Members

ALL_FRAMES

ALL_FRAMES: "ALL_FRAMES"

DISABLED

DISABLED: "DISABLED"

SLICE_TYPE

SLICE_TYPE: "SLICE_TYPE"

Settings

Member Visibility

Theme

On This Page

ALL_FRAMESDISABLEDSLICE_TYPE
\ No newline at end of file +

Enumeration Members

ALL_FRAMES

ALL_FRAMES: "ALL_FRAMES"

DISABLED

DISABLED: "DISABLED"

SLICE_TYPE

SLICE_TYPE: "SLICE_TYPE"

Settings

Member Visibility

Theme

On This Page

ALL_FRAMESDISABLEDSLICE_TYPE
\ No newline at end of file diff --git a/docs/enums/FragmentedMp4MuxingManifestType.html b/docs/enums/FragmentedMp4MuxingManifestType.html index bb85e03b1..542601784 100644 --- a/docs/enums/FragmentedMp4MuxingManifestType.html +++ b/docs/enums/FragmentedMp4MuxingManifestType.html @@ -1,7 +1,7 @@ FragmentedMp4MuxingManifestType | @bitmovin/api-sdk

Enumeration FragmentedMp4MuxingManifestType

Manifest type to be generated for the Fragmented MP4 Muxing. Only significant if a valid fragmentDuration is passed. If this is not set, Smooth Streaming is assumed.

-

Export

Enumeration Members

DASH_ON_DEMAND +

Export

Enumeration Members

DASH_ON_DEMAND HLS_BYTE_RANGES HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST NONE SMOOTH -

Enumeration Members

DASH_ON_DEMAND

DASH_ON_DEMAND: "DASH_ON_DEMAND"

HLS_BYTE_RANGES

HLS_BYTE_RANGES: "HLS_BYTE_RANGES"

HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST

HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST: "HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST"

NONE

NONE: "NONE"

SMOOTH

SMOOTH: "SMOOTH"

Settings

Member Visibility

Theme

On This Page

DASH_ON_DEMANDHLS_BYTE_RANGESHLS_BYTE_RANGES_AND_IFRAME_PLAYLISTNONESMOOTH
\ No newline at end of file +

Enumeration Members

DASH_ON_DEMAND

DASH_ON_DEMAND: "DASH_ON_DEMAND"

HLS_BYTE_RANGES

HLS_BYTE_RANGES: "HLS_BYTE_RANGES"

HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST

HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST: "HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST"

NONE

NONE: "NONE"

SMOOTH

SMOOTH: "SMOOTH"

Settings

Member Visibility

Theme

On This Page

DASH_ON_DEMANDHLS_BYTE_RANGESHLS_BYTE_RANGES_AND_IFRAME_PLAYLISTNONESMOOTH
\ No newline at end of file diff --git a/docs/enums/GoogleCloudRegion.html b/docs/enums/GoogleCloudRegion.html index f4a295d71..5c5ba6606 100644 --- a/docs/enums/GoogleCloudRegion.html +++ b/docs/enums/GoogleCloudRegion.html @@ -1,4 +1,4 @@ -GoogleCloudRegion | @bitmovin/api-sdk

Enumeration GoogleCloudRegion

Export

Enumeration Members

ASIA_EAST_1 +GoogleCloudRegion | @bitmovin/api-sdk

Enumeration GoogleCloudRegion

Export

Enumeration Members

ASIA_EAST_1 ASIA_EAST_2 ASIA_NORTHEAST_1 ASIA_SOUTHEAST_1 @@ -16,4 +16,4 @@ US_EAST_4 US_WEST_1 US_WEST_2 -

Enumeration Members

ASIA_EAST_1

ASIA_EAST_1: "ASIA_EAST_1"

ASIA_EAST_2

ASIA_EAST_2: "ASIA_EAST_2"

ASIA_NORTHEAST_1

ASIA_NORTHEAST_1: "ASIA_NORTHEAST_1"

ASIA_SOUTHEAST_1

ASIA_SOUTHEAST_1: "ASIA_SOUTHEAST_1"

ASIA_SOUTH_1

ASIA_SOUTH_1: "ASIA_SOUTH_1"

AUSTRALIA_SOUTHEAST_1

AUSTRALIA_SOUTHEAST_1: "AUSTRALIA_SOUTHEAST_1"

EUROPE_NORTH_1

EUROPE_NORTH_1: "EUROPE_NORTH_1"

EUROPE_WEST_1

EUROPE_WEST_1: "EUROPE_WEST_1"

EUROPE_WEST_2

EUROPE_WEST_2: "EUROPE_WEST_2"

EUROPE_WEST_3

EUROPE_WEST_3: "EUROPE_WEST_3"

EUROPE_WEST_4

EUROPE_WEST_4: "EUROPE_WEST_4"

NORTHAMERICA_NORTHEAST_1

NORTHAMERICA_NORTHEAST_1: "NORTHAMERICA_NORTHEAST_1"

SOUTHAMERICA_EAST_1

SOUTHAMERICA_EAST_1: "SOUTHAMERICA_EAST_1"

US_CENTRAL_1

US_CENTRAL_1: "US_CENTRAL_1"

US_EAST_1

US_EAST_1: "US_EAST_1"

US_EAST_4

US_EAST_4: "US_EAST_4"

US_WEST_1

US_WEST_1: "US_WEST_1"

US_WEST_2

US_WEST_2: "US_WEST_2"

Settings

Member Visibility

Theme

On This Page

ASIA_EAST_1ASIA_EAST_2ASIA_NORTHEAST_1ASIA_SOUTHEAST_1ASIA_SOUTH_1AUSTRALIA_SOUTHEAST_1EUROPE_NORTH_1EUROPE_WEST_1EUROPE_WEST_2EUROPE_WEST_3EUROPE_WEST_4NORTHAMERICA_NORTHEAST_1SOUTHAMERICA_EAST_1US_CENTRAL_1US_EAST_1US_EAST_4US_WEST_1US_WEST_2
\ No newline at end of file +

Enumeration Members

ASIA_EAST_1

ASIA_EAST_1: "ASIA_EAST_1"

ASIA_EAST_2

ASIA_EAST_2: "ASIA_EAST_2"

ASIA_NORTHEAST_1

ASIA_NORTHEAST_1: "ASIA_NORTHEAST_1"

ASIA_SOUTHEAST_1

ASIA_SOUTHEAST_1: "ASIA_SOUTHEAST_1"

ASIA_SOUTH_1

ASIA_SOUTH_1: "ASIA_SOUTH_1"

AUSTRALIA_SOUTHEAST_1

AUSTRALIA_SOUTHEAST_1: "AUSTRALIA_SOUTHEAST_1"

EUROPE_NORTH_1

EUROPE_NORTH_1: "EUROPE_NORTH_1"

EUROPE_WEST_1

EUROPE_WEST_1: "EUROPE_WEST_1"

EUROPE_WEST_2

EUROPE_WEST_2: "EUROPE_WEST_2"

EUROPE_WEST_3

EUROPE_WEST_3: "EUROPE_WEST_3"

EUROPE_WEST_4

EUROPE_WEST_4: "EUROPE_WEST_4"

NORTHAMERICA_NORTHEAST_1

NORTHAMERICA_NORTHEAST_1: "NORTHAMERICA_NORTHEAST_1"

SOUTHAMERICA_EAST_1

SOUTHAMERICA_EAST_1: "SOUTHAMERICA_EAST_1"

US_CENTRAL_1

US_CENTRAL_1: "US_CENTRAL_1"

US_EAST_1

US_EAST_1: "US_EAST_1"

US_EAST_4

US_EAST_4: "US_EAST_4"

US_WEST_1

US_WEST_1: "US_WEST_1"

US_WEST_2

US_WEST_2: "US_WEST_2"

Settings

Member Visibility

Theme

On This Page

ASIA_EAST_1ASIA_EAST_2ASIA_NORTHEAST_1ASIA_SOUTHEAST_1ASIA_SOUTH_1AUSTRALIA_SOUTHEAST_1EUROPE_NORTH_1EUROPE_WEST_1EUROPE_WEST_2EUROPE_WEST_3EUROPE_WEST_4NORTHAMERICA_NORTHEAST_1SOUTHAMERICA_EAST_1US_CENTRAL_1US_EAST_1US_EAST_4US_WEST_1US_WEST_2
\ No newline at end of file diff --git a/docs/enums/H262InterlaceMode.html b/docs/enums/H262InterlaceMode.html index 1987d3a75..1d1f43daa 100644 --- a/docs/enums/H262InterlaceMode.html +++ b/docs/enums/H262InterlaceMode.html @@ -1,5 +1,5 @@ H262InterlaceMode | @bitmovin/api-sdk

Enumeration H262InterlaceMode

Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video

-

Export

Enumeration Members

BOTTOM_FIELD_FIRST +

Export

Enumeration Members

BOTTOM_FIELD_FIRST NONE TOP_FIELD_FIRST -

Enumeration Members

BOTTOM_FIELD_FIRST

BOTTOM_FIELD_FIRST: "BOTTOM_FIELD_FIRST"

NONE

NONE: "NONE"

TOP_FIELD_FIRST

TOP_FIELD_FIRST: "TOP_FIELD_FIRST"

Settings

Member Visibility

Theme

On This Page

BOTTOM_FIELD_FIRSTNONETOP_FIELD_FIRST
\ No newline at end of file +

Enumeration Members

BOTTOM_FIELD_FIRST

BOTTOM_FIELD_FIRST: "BOTTOM_FIELD_FIRST"

NONE

NONE: "NONE"

TOP_FIELD_FIRST

TOP_FIELD_FIRST: "TOP_FIELD_FIRST"

Settings

Member Visibility

Theme

On This Page

BOTTOM_FIELD_FIRSTNONETOP_FIELD_FIRST
\ No newline at end of file diff --git a/docs/enums/H262PresetConfiguration.html b/docs/enums/H262PresetConfiguration.html index 5d2815704..d25ca9bfb 100644 --- a/docs/enums/H262PresetConfiguration.html +++ b/docs/enums/H262PresetConfiguration.html @@ -1,3 +1,3 @@ H262PresetConfiguration | @bitmovin/api-sdk

Enumeration H262PresetConfiguration

Codec specific settings for XDCAM HD 422.

-

Export

Enumeration Members

XDCAM_HD_422 -

Enumeration Members

XDCAM_HD_422

XDCAM_HD_422: "XDCAM_HD_422"

Settings

Member Visibility

Theme

On This Page

XDCAM_HD_422
\ No newline at end of file +

Export

Enumeration Members

XDCAM_HD_422 +

Enumeration Members

XDCAM_HD_422

XDCAM_HD_422: "XDCAM_HD_422"

Settings

Member Visibility

Theme

On This Page

XDCAM_HD_422
\ No newline at end of file diff --git a/docs/enums/H264BPyramid.html b/docs/enums/H264BPyramid.html index 55a63b233..7347e155c 100644 --- a/docs/enums/H264BPyramid.html +++ b/docs/enums/H264BPyramid.html @@ -1,5 +1,5 @@ H264BPyramid | @bitmovin/api-sdk

Enumeration H264BPyramid

Keep some B-frames as references

-

Export

Enumeration Members

NONE +

Export

Enumeration Members

NONE NORMAL STRICT -

Enumeration Members

NONE

NONE: "NONE"

NORMAL

NORMAL: "NORMAL"

STRICT

STRICT: "STRICT"

Settings

Member Visibility

Theme

On This Page

NONENORMALSTRICT
\ No newline at end of file +

Enumeration Members

NONE

NONE: "NONE"

NORMAL

NORMAL: "NORMAL"

STRICT

STRICT: "STRICT"

Settings

Member Visibility

Theme

On This Page

NONENORMALSTRICT
\ No newline at end of file diff --git a/docs/enums/H264DynamicRangeFormat.html b/docs/enums/H264DynamicRangeFormat.html index 307905c9d..212b0a076 100644 --- a/docs/enums/H264DynamicRangeFormat.html +++ b/docs/enums/H264DynamicRangeFormat.html @@ -1,3 +1,3 @@ H264DynamicRangeFormat | @bitmovin/api-sdk

Enumeration H264DynamicRangeFormat

Ouput should be in Standard Definition Range (SDR).

-

Export

Enumeration Members

SDR -

Enumeration Members

SDR

SDR: "SDR"

Settings

Member Visibility

Theme

On This Page

SDR
\ No newline at end of file +

Export

Enumeration Members

SDR +

Enumeration Members

SDR

SDR: "SDR"

Settings

Member Visibility

Theme

On This Page

SDR
\ No newline at end of file diff --git a/docs/enums/H264InterlaceMode.html b/docs/enums/H264InterlaceMode.html index 8976e2258..1e1fdddfe 100644 --- a/docs/enums/H264InterlaceMode.html +++ b/docs/enums/H264InterlaceMode.html @@ -1,5 +1,5 @@ H264InterlaceMode | @bitmovin/api-sdk

Enumeration H264InterlaceMode

Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video

-

Export

Enumeration Members

BOTTOM_FIELD_FIRST +

Export

Enumeration Members

BOTTOM_FIELD_FIRST NONE TOP_FIELD_FIRST -

Enumeration Members

BOTTOM_FIELD_FIRST

BOTTOM_FIELD_FIRST: "BOTTOM_FIELD_FIRST"

NONE

NONE: "NONE"

TOP_FIELD_FIRST

TOP_FIELD_FIRST: "TOP_FIELD_FIRST"

Settings

Member Visibility

Theme

On This Page

BOTTOM_FIELD_FIRSTNONETOP_FIELD_FIRST
\ No newline at end of file +

Enumeration Members

BOTTOM_FIELD_FIRST

BOTTOM_FIELD_FIRST: "BOTTOM_FIELD_FIRST"

NONE

NONE: "NONE"

TOP_FIELD_FIRST

TOP_FIELD_FIRST: "TOP_FIELD_FIRST"

Settings

Member Visibility

Theme

On This Page

BOTTOM_FIELD_FIRSTNONETOP_FIELD_FIRST
\ No newline at end of file diff --git a/docs/enums/H264MotionEstimationMethod.html b/docs/enums/H264MotionEstimationMethod.html index 62265c0fe..88ad814fa 100644 --- a/docs/enums/H264MotionEstimationMethod.html +++ b/docs/enums/H264MotionEstimationMethod.html @@ -1,5 +1,5 @@ H264MotionEstimationMethod | @bitmovin/api-sdk

Enumeration H264MotionEstimationMethod

Integer pixel motion estimation method

-

Export

Enumeration Members

DIA +

Export

Enumeration Members

DIA HEX UMH -

Enumeration Members

DIA

DIA: "DIA"

HEX

HEX: "HEX"

UMH

UMH: "UMH"

Settings

Member Visibility

Theme

On This Page

DIAHEXUMH
\ No newline at end of file +

Enumeration Members

DIA

DIA: "DIA"

HEX

HEX: "HEX"

UMH

UMH: "UMH"

Settings

Member Visibility

Theme

On This Page

DIAHEXUMH
\ No newline at end of file diff --git a/docs/enums/H264NalHrd.html b/docs/enums/H264NalHrd.html index 849a6be2b..6fe3e0f59 100644 --- a/docs/enums/H264NalHrd.html +++ b/docs/enums/H264NalHrd.html @@ -1,5 +1,5 @@ H264NalHrd | @bitmovin/api-sdk

Enumeration H264NalHrd

Signal hypothetical reference decoder (HRD) information (requires bufsize to be set)

-

Export

Enumeration Members

CBR +

Export

Enumeration Members

CBR NONE VBR -

Enumeration Members

CBR

CBR: "CBR"

NONE

NONE: "NONE"

VBR

VBR: "VBR"

Settings

Member Visibility

Theme

On This Page

CBRNONEVBR
\ No newline at end of file +

Enumeration Members

CBR

CBR: "CBR"

NONE

NONE: "NONE"

VBR

VBR: "VBR"

Settings

Member Visibility

Theme

On This Page

CBRNONEVBR
\ No newline at end of file diff --git a/docs/enums/H264Partition.html b/docs/enums/H264Partition.html index 12fee1bbf..cb0e374f2 100644 --- a/docs/enums/H264Partition.html +++ b/docs/enums/H264Partition.html @@ -1,9 +1,9 @@ H264Partition | @bitmovin/api-sdk

Enumeration H264Partition

Partitions to consider. Analyzing more partition options improves quality at the cost of speed.

-

Export

Enumeration Members

ALL +

Export

Enumeration Members

ALL B8X8 I4X4 I8X8 NONE P4X4 P8X8 -

Enumeration Members

ALL

ALL: "ALL"

B8X8

B8X8: "B8X8"

I4X4

I4X4: "I4X4"

I8X8

I8X8: "I8X8"

NONE

NONE: "NONE"

P4X4

P4X4: "P4X4"

P8X8

P8X8: "P8X8"

Settings

Member Visibility

Theme

On This Page

ALLB8X8I4X4I8X8NONEP4X4P8X8
\ No newline at end of file +

Enumeration Members

ALL

ALL: "ALL"

B8X8

B8X8: "B8X8"

I4X4

I4X4: "I4X4"

I8X8

I8X8: "I8X8"

NONE

NONE: "NONE"

P4X4

P4X4: "P4X4"

P8X8

P8X8: "P8X8"

Settings

Member Visibility

Theme

On This Page

ALLB8X8I4X4I8X8NONEP4X4P8X8
\ No newline at end of file diff --git a/docs/enums/H264SubMe.html b/docs/enums/H264SubMe.html index e6f401476..593761e73 100644 --- a/docs/enums/H264SubMe.html +++ b/docs/enums/H264SubMe.html @@ -1,5 +1,5 @@ H264SubMe | @bitmovin/api-sdk

Enumeration H264SubMe

Subpixel motion estimation and mode decision

-

Export

Enumeration Members

FULLPEL +

Export

Enumeration Members

FULLPEL QPEL3 QPEL4 QPEL5 @@ -9,4 +9,4 @@ RD_REF_IP SAD SATD -

Enumeration Members

FULLPEL

FULLPEL: "FULLPEL"

QPEL3

QPEL3: "QPEL3"

QPEL4

QPEL4: "QPEL4"

QPEL5

QPEL5: "QPEL5"

RD_ALL

RD_ALL: "RD_ALL"

RD_IP

RD_IP: "RD_IP"

RD_REF_ALL

RD_REF_ALL: "RD_REF_ALL"

RD_REF_IP

RD_REF_IP: "RD_REF_IP"

SAD

SAD: "SAD"

SATD

SATD: "SATD"

Settings

Member Visibility

Theme

On This Page

FULLPELQPEL3QPEL4QPEL5RD_ALLRD_IPRD_REF_ALLRD_REF_IPSADSATD
\ No newline at end of file +

Enumeration Members

FULLPEL

FULLPEL: "FULLPEL"

QPEL3

QPEL3: "QPEL3"

QPEL4

QPEL4: "QPEL4"

QPEL5

QPEL5: "QPEL5"

RD_ALL

RD_ALL: "RD_ALL"

RD_IP

RD_IP: "RD_IP"

RD_REF_ALL

RD_REF_ALL: "RD_REF_ALL"

RD_REF_IP

RD_REF_IP: "RD_REF_IP"

SAD

SAD: "SAD"

SATD

SATD: "SATD"

Settings

Member Visibility

Theme

On This Page

FULLPELQPEL3QPEL4QPEL5RD_ALLRD_IPRD_REF_ALLRD_REF_IPSADSATD
\ No newline at end of file diff --git a/docs/enums/H264Trellis.html b/docs/enums/H264Trellis.html index 4fafb970e..fcf08f8c4 100644 --- a/docs/enums/H264Trellis.html +++ b/docs/enums/H264Trellis.html @@ -1,5 +1,5 @@ H264Trellis | @bitmovin/api-sdk

Enumeration H264Trellis

Enables or disables Trellis quantization. NOTE: This requires cabac

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED ENABLED_ALL ENABLED_FINAL_MB -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED_ALL

ENABLED_ALL: "ENABLED_ALL"

ENABLED_FINAL_MB

ENABLED_FINAL_MB: "ENABLED_FINAL_MB"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED_ALLENABLED_FINAL_MB
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED_ALL

ENABLED_ALL: "ENABLED_ALL"

ENABLED_FINAL_MB

ENABLED_FINAL_MB: "ENABLED_FINAL_MB"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED_ALLENABLED_FINAL_MB
\ No newline at end of file diff --git a/docs/enums/H265DynamicRangeFormat.html b/docs/enums/H265DynamicRangeFormat.html index 547549b07..5513ab38f 100644 --- a/docs/enums/H265DynamicRangeFormat.html +++ b/docs/enums/H265DynamicRangeFormat.html @@ -1,6 +1,6 @@ H265DynamicRangeFormat | @bitmovin/api-sdk

Enumeration H265DynamicRangeFormat

Configures what kind of dynamic range the output should conform to. Can be used to convert from SDR to HDR, from HDR to SDR or between different HDR formats

-

Export

Enumeration Members

DOLBY_VISION +

Export

Enumeration Members

DOLBY_VISION HDR10 HLG SDR -

Enumeration Members

DOLBY_VISION

DOLBY_VISION: "DOLBY_VISION"

HDR10

HDR10: "HDR10"

HLG

HLG: "HLG"

SDR

SDR: "SDR"

Settings

Member Visibility

Theme

On This Page

DOLBY_VISIONHDR10HLGSDR
\ No newline at end of file +

Enumeration Members

DOLBY_VISION

DOLBY_VISION: "DOLBY_VISION"

HDR10

HDR10: "HDR10"

HLG

HLG: "HLG"

SDR

SDR: "SDR"

Settings

Member Visibility

Theme

On This Page

DOLBY_VISIONHDR10HLGSDR
\ No newline at end of file diff --git a/docs/enums/HeAacV1Signaling.html b/docs/enums/HeAacV1Signaling.html index d5d5f47ba..bb1b291a7 100644 --- a/docs/enums/HeAacV1Signaling.html +++ b/docs/enums/HeAacV1Signaling.html @@ -1,4 +1,4 @@ -HeAacV1Signaling | @bitmovin/api-sdk

Enumeration HeAacV1Signaling

Export

Enumeration Members

EXPLICIT_HIERARCHICAL +HeAacV1Signaling | @bitmovin/api-sdk

Enumeration HeAacV1Signaling

Export

Enumeration Members

EXPLICIT_HIERARCHICAL EXPLICIT_SBR IMPLICIT -

Enumeration Members

EXPLICIT_HIERARCHICAL

EXPLICIT_HIERARCHICAL: "EXPLICIT_HIERARCHICAL"

EXPLICIT_SBR

EXPLICIT_SBR: "EXPLICIT_SBR"

IMPLICIT

IMPLICIT: "IMPLICIT"

Settings

Member Visibility

Theme

On This Page

EXPLICIT_HIERARCHICALEXPLICIT_SBRIMPLICIT
\ No newline at end of file +

Enumeration Members

EXPLICIT_HIERARCHICAL

EXPLICIT_HIERARCHICAL: "EXPLICIT_HIERARCHICAL"

EXPLICIT_SBR

EXPLICIT_SBR: "EXPLICIT_SBR"

IMPLICIT

IMPLICIT: "IMPLICIT"

Settings

Member Visibility

Theme

On This Page

EXPLICIT_HIERARCHICALEXPLICIT_SBRIMPLICIT
\ No newline at end of file diff --git a/docs/enums/HeAacV2Signaling.html b/docs/enums/HeAacV2Signaling.html index 91e71d20b..929fa63bb 100644 --- a/docs/enums/HeAacV2Signaling.html +++ b/docs/enums/HeAacV2Signaling.html @@ -1,5 +1,5 @@ -HeAacV2Signaling | @bitmovin/api-sdk

Enumeration HeAacV2Signaling

Export

Enumeration Members

EXPLICIT_HIERARCHICAL +HeAacV2Signaling | @bitmovin/api-sdk

Enumeration HeAacV2Signaling

Export

Enumeration Members

EXPLICIT_HIERARCHICAL EXPLICIT_PS EXPLICIT_SBR IMPLICIT -

Enumeration Members

EXPLICIT_HIERARCHICAL

EXPLICIT_HIERARCHICAL: "EXPLICIT_HIERARCHICAL"

EXPLICIT_PS

EXPLICIT_PS: "EXPLICIT_PS"

EXPLICIT_SBR

EXPLICIT_SBR: "EXPLICIT_SBR"

IMPLICIT

IMPLICIT: "IMPLICIT"

Settings

Member Visibility

Theme

On This Page

EXPLICIT_HIERARCHICALEXPLICIT_PSEXPLICIT_SBRIMPLICIT
\ No newline at end of file +

Enumeration Members

EXPLICIT_HIERARCHICAL

EXPLICIT_HIERARCHICAL: "EXPLICIT_HIERARCHICAL"

EXPLICIT_PS

EXPLICIT_PS: "EXPLICIT_PS"

EXPLICIT_SBR

EXPLICIT_SBR: "EXPLICIT_SBR"

IMPLICIT

IMPLICIT: "IMPLICIT"

Settings

Member Visibility

Theme

On This Page

EXPLICIT_HIERARCHICALEXPLICIT_PSEXPLICIT_SBRIMPLICIT
\ No newline at end of file diff --git a/docs/enums/HlsManifestAdMarkerType.html b/docs/enums/HlsManifestAdMarkerType.html index 768286843..9f77d9025 100644 --- a/docs/enums/HlsManifestAdMarkerType.html +++ b/docs/enums/HlsManifestAdMarkerType.html @@ -1,7 +1,7 @@ HlsManifestAdMarkerType | @bitmovin/api-sdk

Enumeration HlsManifestAdMarkerType

HLS Manifest ad marker types

-

Export

Enumeration Members

EXT_OATCLS_SCTE35 +

Export

Enumeration Members

EXT_OATCLS_SCTE35 EXT_X_CUE_OUT_IN EXT_X_DATERANGE EXT_X_SCTE35 EXT_X_SPLICEPOINT_SCTE35 -

Enumeration Members

EXT_OATCLS_SCTE35

EXT_OATCLS_SCTE35: "EXT_OATCLS_SCTE35"

EXT_X_CUE_OUT_IN

EXT_X_CUE_OUT_IN: "EXT_X_CUE_OUT_IN"

EXT_X_DATERANGE

EXT_X_DATERANGE: "EXT_X_DATERANGE"

EXT_X_SCTE35

EXT_X_SCTE35: "EXT_X_SCTE35"

EXT_X_SPLICEPOINT_SCTE35

EXT_X_SPLICEPOINT_SCTE35: "EXT_X_SPLICEPOINT_SCTE35"

Settings

Member Visibility

Theme

On This Page

EXT_OATCLS_SCTE35EXT_X_CUE_OUT_INEXT_X_DATERANGEEXT_X_SCTE35EXT_X_SPLICEPOINT_SCTE35
\ No newline at end of file +

Enumeration Members

EXT_OATCLS_SCTE35

EXT_OATCLS_SCTE35: "EXT_OATCLS_SCTE35"

EXT_X_CUE_OUT_IN

EXT_X_CUE_OUT_IN: "EXT_X_CUE_OUT_IN"

EXT_X_DATERANGE

EXT_X_DATERANGE: "EXT_X_DATERANGE"

EXT_X_SCTE35

EXT_X_SCTE35: "EXT_X_SCTE35"

EXT_X_SPLICEPOINT_SCTE35

EXT_X_SPLICEPOINT_SCTE35: "EXT_X_SPLICEPOINT_SCTE35"

Settings

Member Visibility

Theme

On This Page

EXT_OATCLS_SCTE35EXT_X_CUE_OUT_INEXT_X_DATERANGEEXT_X_SCTE35EXT_X_SPLICEPOINT_SCTE35
\ No newline at end of file diff --git a/docs/enums/HlsManifestDefaultVersion.html b/docs/enums/HlsManifestDefaultVersion.html index 9480bb936..01537a930 100644 --- a/docs/enums/HlsManifestDefaultVersion.html +++ b/docs/enums/HlsManifestDefaultVersion.html @@ -1,2 +1,2 @@ -HlsManifestDefaultVersion | @bitmovin/api-sdk

Enumeration HlsManifestDefaultVersion

Export

Enumeration Members

V1 -

Enumeration Members

V1

V1: "V1"

Settings

Member Visibility

Theme

On This Page

V1
\ No newline at end of file +HlsManifestDefaultVersion | @bitmovin/api-sdk

Enumeration HlsManifestDefaultVersion

Export

Enumeration Members

V1 +

Enumeration Members

V1

V1: "V1"

Settings

Member Visibility

Theme

On This Page

V1
\ No newline at end of file diff --git a/docs/enums/HlsTargetDurationRoundingMode.html b/docs/enums/HlsTargetDurationRoundingMode.html index 980d460c7..76eb4316c 100644 --- a/docs/enums/HlsTargetDurationRoundingMode.html +++ b/docs/enums/HlsTargetDurationRoundingMode.html @@ -1,3 +1,3 @@ -HlsTargetDurationRoundingMode | @bitmovin/api-sdk

Enumeration HlsTargetDurationRoundingMode

Export

Enumeration Members

NORMAL_ROUNDING +HlsTargetDurationRoundingMode | @bitmovin/api-sdk

Enumeration HlsTargetDurationRoundingMode

Export

Enumeration Members

NORMAL_ROUNDING UPWARD_ROUNDING -

Enumeration Members

NORMAL_ROUNDING

NORMAL_ROUNDING: "NORMAL_ROUNDING"

UPWARD_ROUNDING

UPWARD_ROUNDING: "UPWARD_ROUNDING"

Settings

Member Visibility

Theme

On This Page

NORMAL_ROUNDINGUPWARD_ROUNDING
\ No newline at end of file +

Enumeration Members

NORMAL_ROUNDING

NORMAL_ROUNDING: "NORMAL_ROUNDING"

UPWARD_ROUNDING

UPWARD_ROUNDING: "UPWARD_ROUNDING"

Settings

Member Visibility

Theme

On This Page

NORMAL_ROUNDINGUPWARD_ROUNDING
\ No newline at end of file diff --git a/docs/enums/HlsVersion.html b/docs/enums/HlsVersion.html index 590737521..0a7391691 100644 --- a/docs/enums/HlsVersion.html +++ b/docs/enums/HlsVersion.html @@ -1,7 +1,7 @@ -HlsVersion | @bitmovin/api-sdk

Enumeration HlsVersion

Export

Enumeration Members

HLS_V3 +HlsVersion | @bitmovin/api-sdk

Enumeration HlsVersion

Export

Enumeration Members

HLS_V3 HLS_V4 HLS_V5 HLS_V6 HLS_V7 HLS_V8 -

Enumeration Members

HLS_V3

HLS_V3: "3"

HLS_V4

HLS_V4: "4"

HLS_V5

HLS_V5: "5"

HLS_V6

HLS_V6: "6"

HLS_V7

HLS_V7: "7"

HLS_V8

HLS_V8: "8"

Settings

Member Visibility

Theme

On This Page

HLS_V3HLS_V4HLS_V5HLS_V6HLS_V7HLS_V8
\ No newline at end of file +

Enumeration Members

HLS_V3

HLS_V3: "3"

HLS_V4

HLS_V4: "4"

HLS_V5

HLS_V5: "5"

HLS_V6

HLS_V6: "6"

HLS_V7

HLS_V7: "7"

HLS_V8

HLS_V8: "8"

Settings

Member Visibility

Theme

On This Page

HLS_V3HLS_V4HLS_V5HLS_V6HLS_V7HLS_V8
\ No newline at end of file diff --git a/docs/enums/Id3TagPositionMode.html b/docs/enums/Id3TagPositionMode.html index 6d3a3da17..fca571ddc 100644 --- a/docs/enums/Id3TagPositionMode.html +++ b/docs/enums/Id3TagPositionMode.html @@ -1,3 +1,3 @@ -Id3TagPositionMode | @bitmovin/api-sdk

Enumeration Id3TagPositionMode

Export

Enumeration Members

FRAME +Id3TagPositionMode | @bitmovin/api-sdk

Enumeration Id3TagPositionMode

Export

Enumeration Members

FRAME TIME -

Enumeration Members

FRAME

FRAME: "FRAME"

TIME

TIME: "TIME"

Settings

Member Visibility

Theme

On This Page

FRAMETIME
\ No newline at end of file +

Enumeration Members

FRAME

FRAME: "FRAME"

TIME

TIME: "TIME"

Settings

Member Visibility

Theme

On This Page

FRAMETIME
\ No newline at end of file diff --git a/docs/enums/Id3TagType.html b/docs/enums/Id3TagType.html index 3b17be9b7..160844857 100644 --- a/docs/enums/Id3TagType.html +++ b/docs/enums/Id3TagType.html @@ -1,4 +1,4 @@ -Id3TagType | @bitmovin/api-sdk

Enumeration Id3TagType

Export

Enumeration Members

FRAME_ID +Id3TagType | @bitmovin/api-sdk

Enumeration Id3TagType

Export

Enumeration Members

FRAME_ID PLAIN_TEXT RAW -

Enumeration Members

FRAME_ID

FRAME_ID: "FRAME_ID"

PLAIN_TEXT

PLAIN_TEXT: "PLAIN_TEXT"

RAW

RAW: "RAW"

Settings

Member Visibility

Theme

On This Page

FRAME_IDPLAIN_TEXTRAW
\ No newline at end of file +

Enumeration Members

FRAME_ID

FRAME_ID: "FRAME_ID"

PLAIN_TEXT

PLAIN_TEXT: "PLAIN_TEXT"

RAW

RAW: "RAW"

Settings

Member Visibility

Theme

On This Page

FRAME_IDPLAIN_TEXTRAW
\ No newline at end of file diff --git a/docs/enums/IgnoredBy.html b/docs/enums/IgnoredBy.html index 2772f7c86..ae4e7c073 100644 --- a/docs/enums/IgnoredBy.html +++ b/docs/enums/IgnoredBy.html @@ -1,2 +1,2 @@ -IgnoredBy | @bitmovin/api-sdk

Enumeration IgnoredBy

Export

Enumeration Members

CONDITION -

Enumeration Members

CONDITION

CONDITION: "CONDITION"

Settings

Member Visibility

Theme

On This Page

CONDITION
\ No newline at end of file +IgnoredBy | @bitmovin/api-sdk

Enumeration IgnoredBy

Export

Enumeration Members

CONDITION +

Enumeration Members

CONDITION

CONDITION: "CONDITION"

Settings

Member Visibility

Theme

On This Page

CONDITION
\ No newline at end of file diff --git a/docs/enums/ImscStylingMode.html b/docs/enums/ImscStylingMode.html index 09ab43780..30c8857e3 100644 --- a/docs/enums/ImscStylingMode.html +++ b/docs/enums/ImscStylingMode.html @@ -1,4 +1,4 @@ ImscStylingMode | @bitmovin/api-sdk

Enumeration ImscStylingMode

Determines how IMSC styling is handled.

-

Export

Enumeration Members

DROP_STYLING +

Export

Enumeration Members

DROP_STYLING PASSTHROUGH -

Enumeration Members

DROP_STYLING

DROP_STYLING: "DROP_STYLING"

PASSTHROUGH

PASSTHROUGH: "PASSTHROUGH"

Settings

Member Visibility

Theme

On This Page

DROP_STYLINGPASSTHROUGH
\ No newline at end of file +

Enumeration Members

DROP_STYLING

DROP_STYLING: "DROP_STYLING"

PASSTHROUGH

PASSTHROUGH: "PASSTHROUGH"

Settings

Member Visibility

Theme

On This Page

DROP_STYLINGPASSTHROUGH
\ No newline at end of file diff --git a/docs/enums/InputColorPrimaries.html b/docs/enums/InputColorPrimaries.html index 88e5a9c2a..86a801972 100644 --- a/docs/enums/InputColorPrimaries.html +++ b/docs/enums/InputColorPrimaries.html @@ -1,4 +1,4 @@ -InputColorPrimaries | @bitmovin/api-sdk

Enumeration InputColorPrimaries

Export

Enumeration Members

BT2020 +InputColorPrimaries | @bitmovin/api-sdk

Enumeration InputColorPrimaries

Export

Enumeration Members

BT2020 BT470BG BT470M BT709 @@ -11,4 +11,4 @@ SMPTE432 SMPTEST428_1 UNSPECIFIED -

Enumeration Members

BT2020

BT2020: "BT2020"

BT470BG

BT470BG: "BT470BG"

BT470M

BT470M: "BT470M"

BT709

BT709: "BT709"

FILM

FILM: "FILM"

JEDEC_P22

JEDEC_P22: "JEDEC_P22"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE240M

SMPTE240M: "SMPTE240M"

SMPTE428

SMPTE428: "SMPTE428"

SMPTE431

SMPTE431: "SMPTE431"

SMPTE432

SMPTE432: "SMPTE432"

SMPTEST428_1

SMPTEST428_1: "SMPTEST428_1"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

BT2020BT470BGBT470MBT709FILMJEDEC_P22SMPTE170MSMPTE240MSMPTE428SMPTE431SMPTE432SMPTEST428_1UNSPECIFIED
\ No newline at end of file +

Enumeration Members

BT2020

BT2020: "BT2020"

BT470BG

BT470BG: "BT470BG"

BT470M

BT470M: "BT470M"

BT709

BT709: "BT709"

FILM

FILM: "FILM"

JEDEC_P22

JEDEC_P22: "JEDEC_P22"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE240M

SMPTE240M: "SMPTE240M"

SMPTE428

SMPTE428: "SMPTE428"

SMPTE431

SMPTE431: "SMPTE431"

SMPTE432

SMPTE432: "SMPTE432"

SMPTEST428_1

SMPTEST428_1: "SMPTEST428_1"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

BT2020BT470BGBT470MBT709FILMJEDEC_P22SMPTE170MSMPTE240MSMPTE428SMPTE431SMPTE432SMPTEST428_1UNSPECIFIED
\ No newline at end of file diff --git a/docs/enums/InputColorRange.html b/docs/enums/InputColorRange.html index e4dfeeca3..492011f62 100644 --- a/docs/enums/InputColorRange.html +++ b/docs/enums/InputColorRange.html @@ -1,5 +1,5 @@ InputColorRange | @bitmovin/api-sdk

Enumeration InputColorRange

Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.

-

Export

Enumeration Members

JPEG +

Export

Enumeration Members

JPEG MPEG UNSPECIFIED -

Enumeration Members

JPEG

JPEG: "JPEG"

MPEG

MPEG: "MPEG"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

JPEGMPEGUNSPECIFIED
\ No newline at end of file +

Enumeration Members

JPEG

JPEG: "JPEG"

MPEG

MPEG: "MPEG"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

JPEGMPEGUNSPECIFIED
\ No newline at end of file diff --git a/docs/enums/InputColorSpace.html b/docs/enums/InputColorSpace.html index 1092cbf7f..ffe89a92c 100644 --- a/docs/enums/InputColorSpace.html +++ b/docs/enums/InputColorSpace.html @@ -1,5 +1,5 @@ InputColorSpace | @bitmovin/api-sdk

Enumeration InputColorSpace

Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.

-

Export

Enumeration Members

BT2020_CL +

Export

Enumeration Members

BT2020_CL BT2020_NCL BT470BG BT709 @@ -11,4 +11,4 @@ UNSPECIFIED YCGCO YCOCG -

Enumeration Members

BT2020_CL

BT2020_CL: "BT2020_CL"

BT2020_NCL

BT2020_NCL: "BT2020_NCL"

BT470BG

BT470BG: "BT470BG"

BT709

BT709: "BT709"

FCC

FCC: "FCC"

RGB

RGB: "RGB"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE2085

SMPTE2085: "SMPTE2085"

SMPTE240M

SMPTE240M: "SMPTE240M"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

YCGCO

YCGCO: "YCGCO"

YCOCG

YCOCG: "YCOCG"

Settings

Member Visibility

Theme

On This Page

BT2020_CLBT2020_NCLBT470BGBT709FCCRGBSMPTE170MSMPTE2085SMPTE240MUNSPECIFIEDYCGCOYCOCG
\ No newline at end of file +

Enumeration Members

BT2020_CL

BT2020_CL: "BT2020_CL"

BT2020_NCL

BT2020_NCL: "BT2020_NCL"

BT470BG

BT470BG: "BT470BG"

BT709

BT709: "BT709"

FCC

FCC: "FCC"

RGB

RGB: "RGB"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE2085

SMPTE2085: "SMPTE2085"

SMPTE240M

SMPTE240M: "SMPTE240M"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

YCGCO

YCGCO: "YCGCO"

YCOCG

YCOCG: "YCOCG"

Settings

Member Visibility

Theme

On This Page

BT2020_CLBT2020_NCLBT470BGBT709FCCRGBSMPTE170MSMPTE2085SMPTE240MUNSPECIFIEDYCGCOYCOCG
\ No newline at end of file diff --git a/docs/enums/InputColorTransfer.html b/docs/enums/InputColorTransfer.html index 73a2cfc02..be7aa2705 100644 --- a/docs/enums/InputColorTransfer.html +++ b/docs/enums/InputColorTransfer.html @@ -1,4 +1,4 @@ -InputColorTransfer | @bitmovin/api-sdk

Enumeration InputColorTransfer

Export

Enumeration Members

ARIB_STD_B67 +InputColorTransfer | @bitmovin/api-sdk

Enumeration InputColorTransfer

Export

Enumeration Members

ARIB_STD_B67 BT1361_ECG BT2020_10 BT2020_12 @@ -15,4 +15,4 @@ SMPTE240M SMPTE428 UNSPECIFIED -

Enumeration Members

ARIB_STD_B67

ARIB_STD_B67: "ARIB_STD_B67"

BT1361_ECG

BT1361_ECG: "BT1361_ECG"

BT2020_10

BT2020_10: "BT2020_10"

BT2020_12

BT2020_12: "BT2020_12"

BT709

BT709: "BT709"

GAMMA22

GAMMA22: "GAMMA22"

GAMMA28

GAMMA28: "GAMMA28"

IEC61966_2_1

IEC61966_2_1: "IEC61966_2_1"

IEC61966_2_4

IEC61966_2_4: "IEC61966_2_4"

LINEAR

LINEAR: "LINEAR"

LOG

LOG: "LOG"

LOG_SQRT

LOG_SQRT: "LOG_SQRT"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE2084

SMPTE2084: "SMPTE2084"

SMPTE240M

SMPTE240M: "SMPTE240M"

SMPTE428

SMPTE428: "SMPTE428"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

ARIB_STD_B67BT1361_ECGBT2020_10BT2020_12BT709GAMMA22GAMMA28IEC61966_2_1IEC61966_2_4LINEARLOGLOG_SQRTSMPTE170MSMPTE2084SMPTE240MSMPTE428UNSPECIFIED
\ No newline at end of file +

Enumeration Members

ARIB_STD_B67

ARIB_STD_B67: "ARIB_STD_B67"

BT1361_ECG

BT1361_ECG: "BT1361_ECG"

BT2020_10

BT2020_10: "BT2020_10"

BT2020_12

BT2020_12: "BT2020_12"

BT709

BT709: "BT709"

GAMMA22

GAMMA22: "GAMMA22"

GAMMA28

GAMMA28: "GAMMA28"

IEC61966_2_1

IEC61966_2_1: "IEC61966_2_1"

IEC61966_2_4

IEC61966_2_4: "IEC61966_2_4"

LINEAR

LINEAR: "LINEAR"

LOG

LOG: "LOG"

LOG_SQRT

LOG_SQRT: "LOG_SQRT"

SMPTE170M

SMPTE170M: "SMPTE170M"

SMPTE2084

SMPTE2084: "SMPTE2084"

SMPTE240M

SMPTE240M: "SMPTE240M"

SMPTE428

SMPTE428: "SMPTE428"

UNSPECIFIED

UNSPECIFIED: "UNSPECIFIED"

Settings

Member Visibility

Theme

On This Page

ARIB_STD_B67BT1361_ECGBT2020_10BT2020_12BT709GAMMA22GAMMA28IEC61966_2_1IEC61966_2_4LINEARLOGLOG_SQRTSMPTE170MSMPTE2084SMPTE240MSMPTE428UNSPECIFIED
\ No newline at end of file diff --git a/docs/enums/InputStreamType.html b/docs/enums/InputStreamType.html index 783e687a9..768ab56dd 100644 --- a/docs/enums/InputStreamType.html +++ b/docs/enums/InputStreamType.html @@ -1,4 +1,4 @@ -InputStreamType | @bitmovin/api-sdk

Enumeration InputStreamType

Export

Enumeration Members

AUDIO_MIX +InputStreamType | @bitmovin/api-sdk

Enumeration InputStreamType

Export

Enumeration Members

AUDIO_MIX CAPTION_CEA608 CAPTION_CEA708 CONCATENATION @@ -11,4 +11,4 @@ TRIMMING_H264_PICTURE_TIMING TRIMMING_TIME_BASED TRIMMING_TIME_CODE_TRACK -

Enumeration Members

AUDIO_MIX

AUDIO_MIX: "AUDIO_MIX"

CAPTION_CEA608

CAPTION_CEA608: "CAPTION_CEA608"

CAPTION_CEA708

CAPTION_CEA708: "CAPTION_CEA708"

CONCATENATION

CONCATENATION: "CONCATENATION"

DOLBY_ATMOS

DOLBY_ATMOS: "DOLBY_ATMOS"

DOLBY_VISION

DOLBY_VISION: "DOLBY_VISION"

DVB_SUBTITLE

DVB_SUBTITLE: "DVB_SUBTITLE"

FILE

FILE: "FILE"

INGEST

INGEST: "INGEST"

SIDECAR_DOLBY_VISION_METADATA

SIDECAR_DOLBY_VISION_METADATA: "SIDECAR_DOLBY_VISION_METADATA"

TRIMMING_H264_PICTURE_TIMING

TRIMMING_H264_PICTURE_TIMING: "TRIMMING_H264_PICTURE_TIMING"

TRIMMING_TIME_BASED

TRIMMING_TIME_BASED: "TRIMMING_TIME_BASED"

TRIMMING_TIME_CODE_TRACK

TRIMMING_TIME_CODE_TRACK: "TRIMMING_TIME_CODE_TRACK"

Settings

Member Visibility

Theme

On This Page

AUDIO_MIXCAPTION_CEA608CAPTION_CEA708CONCATENATIONDOLBY_ATMOSDOLBY_VISIONDVB_SUBTITLEFILEINGESTSIDECAR_DOLBY_VISION_METADATATRIMMING_H264_PICTURE_TIMINGTRIMMING_TIME_BASEDTRIMMING_TIME_CODE_TRACK
\ No newline at end of file +

Enumeration Members

AUDIO_MIX

AUDIO_MIX: "AUDIO_MIX"

CAPTION_CEA608

CAPTION_CEA608: "CAPTION_CEA608"

CAPTION_CEA708

CAPTION_CEA708: "CAPTION_CEA708"

CONCATENATION

CONCATENATION: "CONCATENATION"

DOLBY_ATMOS

DOLBY_ATMOS: "DOLBY_ATMOS"

DOLBY_VISION

DOLBY_VISION: "DOLBY_VISION"

DVB_SUBTITLE

DVB_SUBTITLE: "DVB_SUBTITLE"

FILE

FILE: "FILE"

INGEST

INGEST: "INGEST"

SIDECAR_DOLBY_VISION_METADATA

SIDECAR_DOLBY_VISION_METADATA: "SIDECAR_DOLBY_VISION_METADATA"

TRIMMING_H264_PICTURE_TIMING

TRIMMING_H264_PICTURE_TIMING: "TRIMMING_H264_PICTURE_TIMING"

TRIMMING_TIME_BASED

TRIMMING_TIME_BASED: "TRIMMING_TIME_BASED"

TRIMMING_TIME_CODE_TRACK

TRIMMING_TIME_CODE_TRACK: "TRIMMING_TIME_CODE_TRACK"

Settings

Member Visibility

Theme

On This Page

AUDIO_MIXCAPTION_CEA608CAPTION_CEA708CONCATENATIONDOLBY_ATMOSDOLBY_VISIONDVB_SUBTITLEFILEINGESTSIDECAR_DOLBY_VISION_METADATATRIMMING_H264_PICTURE_TIMINGTRIMMING_TIME_BASEDTRIMMING_TIME_CODE_TRACK
\ No newline at end of file diff --git a/docs/enums/InputType.html b/docs/enums/InputType.html index 7566e653d..b9760a829 100644 --- a/docs/enums/InputType.html +++ b/docs/enums/InputType.html @@ -1,4 +1,4 @@ -InputType | @bitmovin/api-sdk

Enumeration InputType

Export

Enumeration Members

AKAMAI_NETSTORAGE +InputType | @bitmovin/api-sdk

Enumeration InputType

Export

Enumeration Members

AKAMAI_NETSTORAGE ASPERA AZURE DIRECT_FILE_UPLOAD @@ -16,4 +16,4 @@ SFTP SRT ZIXI -

Enumeration Members

AKAMAI_NETSTORAGE

AKAMAI_NETSTORAGE: "AKAMAI_NETSTORAGE"

ASPERA

ASPERA: "ASPERA"

AZURE

AZURE: "AZURE"

DIRECT_FILE_UPLOAD

DIRECT_FILE_UPLOAD: "DIRECT_FILE_UPLOAD"

FTP

FTP: "FTP"

GCS

GCS: "GCS"

GCS_SERVICE_ACCOUNT

GCS_SERVICE_ACCOUNT: "GCS_SERVICE_ACCOUNT"

GENERIC_S3

GENERIC_S3: "GENERIC_S3"

HTTP

HTTP: "HTTP"

HTTPS

HTTPS: "HTTPS"

LOCAL

LOCAL: "LOCAL"

REDUNDANT_RTMP

REDUNDANT_RTMP: "REDUNDANT_RTMP"

RTMP

RTMP: "RTMP"

S3

S3: "S3"

S3_ROLE_BASED

S3_ROLE_BASED: "S3_ROLE_BASED"

SFTP

SFTP: "SFTP"

SRT

SRT: "SRT"

ZIXI

ZIXI: "ZIXI"

Settings

Member Visibility

Theme

On This Page

AKAMAI_NETSTORAGEASPERAAZUREDIRECT_FILE_UPLOADFTPGCSGCS_SERVICE_ACCOUNTGENERIC_S3HTTPHTTPSLOCALREDUNDANT_RTMPRTMPS3S3_ROLE_BASEDSFTPSRTZIXI
\ No newline at end of file +

Enumeration Members

AKAMAI_NETSTORAGE

AKAMAI_NETSTORAGE: "AKAMAI_NETSTORAGE"

ASPERA

ASPERA: "ASPERA"

AZURE

AZURE: "AZURE"

DIRECT_FILE_UPLOAD

DIRECT_FILE_UPLOAD: "DIRECT_FILE_UPLOAD"

FTP

FTP: "FTP"

GCS

GCS: "GCS"

GCS_SERVICE_ACCOUNT

GCS_SERVICE_ACCOUNT: "GCS_SERVICE_ACCOUNT"

GENERIC_S3

GENERIC_S3: "GENERIC_S3"

HTTP

HTTP: "HTTP"

HTTPS

HTTPS: "HTTPS"

LOCAL

LOCAL: "LOCAL"

REDUNDANT_RTMP

REDUNDANT_RTMP: "REDUNDANT_RTMP"

RTMP

RTMP: "RTMP"

S3

S3: "S3"

S3_ROLE_BASED

S3_ROLE_BASED: "S3_ROLE_BASED"

SFTP

SFTP: "SFTP"

SRT

SRT: "SRT"

ZIXI

ZIXI: "ZIXI"

Settings

Member Visibility

Theme

On This Page

AKAMAI_NETSTORAGEASPERAAZUREDIRECT_FILE_UPLOADFTPGCSGCS_SERVICE_ACCOUNTGENERIC_S3HTTPHTTPSLOCALREDUNDANT_RTMPRTMPS3S3_ROLE_BASEDSFTPSRTZIXI
\ No newline at end of file diff --git a/docs/enums/InsertableContentStatus.html b/docs/enums/InsertableContentStatus.html index dc3340b79..2f247f0f2 100644 --- a/docs/enums/InsertableContentStatus.html +++ b/docs/enums/InsertableContentStatus.html @@ -1,5 +1,5 @@ -InsertableContentStatus | @bitmovin/api-sdk

Enumeration InsertableContentStatus

Export

Enumeration Members

CREATED +InsertableContentStatus | @bitmovin/api-sdk

Enumeration InsertableContentStatus

Export

Enumeration Members

CREATED DOWNLOADING ERROR READY -

Enumeration Members

CREATED

CREATED: "CREATED"

DOWNLOADING

DOWNLOADING: "DOWNLOADING"

ERROR

ERROR: "ERROR"

READY

READY: "READY"

Settings

Member Visibility

Theme

On This Page

CREATEDDOWNLOADINGERRORREADY
\ No newline at end of file +

Enumeration Members

CREATED

CREATED: "CREATED"

DOWNLOADING

DOWNLOADING: "DOWNLOADING"

ERROR

ERROR: "ERROR"

READY

READY: "READY"

Settings

Member Visibility

Theme

On This Page

CREATEDDOWNLOADINGERRORREADY
\ No newline at end of file diff --git a/docs/enums/InterlaceMode.html b/docs/enums/InterlaceMode.html index a8e730182..c07acdbe1 100644 --- a/docs/enums/InterlaceMode.html +++ b/docs/enums/InterlaceMode.html @@ -1,5 +1,5 @@ InterlaceMode | @bitmovin/api-sdk

Enumeration InterlaceMode

How to interleave the input frames

-

Export

Enumeration Members

BOTTOM +

Export

Enumeration Members

BOTTOM DROP_EVEN DROP_ODD INTERLACE_X2 @@ -7,4 +7,4 @@ MERGE_X2 PAD TOP -

Enumeration Members

BOTTOM

BOTTOM: "BOTTOM"

DROP_EVEN

DROP_EVEN: "DROP_EVEN"

DROP_ODD

DROP_ODD: "DROP_ODD"

INTERLACE_X2

INTERLACE_X2: "INTERLACE_X2"

MERGE

MERGE: "MERGE"

MERGE_X2

MERGE_X2: "MERGE_X2"

PAD

PAD: "PAD"

TOP

TOP: "TOP"

Settings

Member Visibility

Theme

On This Page

BOTTOMDROP_EVENDROP_ODDINTERLACE_X2MERGEMERGE_X2PADTOP
\ No newline at end of file +

Enumeration Members

BOTTOM

BOTTOM: "BOTTOM"

DROP_EVEN

DROP_EVEN: "DROP_EVEN"

DROP_ODD

DROP_ODD: "DROP_ODD"

INTERLACE_X2

INTERLACE_X2: "INTERLACE_X2"

MERGE

MERGE: "MERGE"

MERGE_X2

MERGE_X2: "MERGE_X2"

PAD

PAD: "PAD"

TOP

TOP: "TOP"

Settings

Member Visibility

Theme

On This Page

BOTTOMDROP_EVENDROP_ODDINTERLACE_X2MERGEMERGE_X2PADTOP
\ No newline at end of file diff --git a/docs/enums/InvitationStatus.html b/docs/enums/InvitationStatus.html index c8a6e2fb9..b4535d07c 100644 --- a/docs/enums/InvitationStatus.html +++ b/docs/enums/InvitationStatus.html @@ -1,4 +1,4 @@ InvitationStatus | @bitmovin/api-sdk

Enumeration InvitationStatus

Status of the invitation

-

Export

Enumeration Members

ACCEPTED +

Export

Enumeration Members

ACCEPTED PENDING -

Enumeration Members

ACCEPTED

ACCEPTED: "ACCEPTED"

PENDING

PENDING: "PENDING"

Settings

Member Visibility

Theme

On This Page

ACCEPTEDPENDING
\ No newline at end of file +

Enumeration Members

ACCEPTED

ACCEPTED: "ACCEPTED"

PENDING

PENDING: "PENDING"

Settings

Member Visibility

Theme

On This Page

ACCEPTEDPENDING
\ No newline at end of file diff --git a/docs/enums/IvSize.html b/docs/enums/IvSize.html index f36b8f290..c42d510bb 100644 --- a/docs/enums/IvSize.html +++ b/docs/enums/IvSize.html @@ -1,3 +1,3 @@ -IvSize | @bitmovin/api-sdk

Enumeration IvSize

Export

Enumeration Members

IV_16_BYTES +IvSize | @bitmovin/api-sdk

Enumeration IvSize

Export

Enumeration Members

IV_16_BYTES IV_8_BYTES -

Enumeration Members

IV_16_BYTES

IV_16_BYTES: "16_BYTES"

IV_8_BYTES

IV_8_BYTES: "8_BYTES"

Settings

Member Visibility

Theme

On This Page

IV_16_BYTESIV_8_BYTES
\ No newline at end of file +

Enumeration Members

IV_16_BYTES

IV_16_BYTES: "16_BYTES"

IV_8_BYTES

IV_8_BYTES: "8_BYTES"

Settings

Member Visibility

Theme

On This Page

IV_16_BYTESIV_8_BYTES
\ No newline at end of file diff --git a/docs/enums/LevelH262.html b/docs/enums/LevelH262.html index db7b6d58f..e1bab35bb 100644 --- a/docs/enums/LevelH262.html +++ b/docs/enums/LevelH262.html @@ -1,4 +1,4 @@ LevelH262 | @bitmovin/api-sdk

Enumeration LevelH262

Specified set of constraints that indicate a degree of required decoder performance for a profile, see: https://en.wikipedia.org/wiki/H.264/MPEG-4_AVC#Levels

-

Export

Enumeration Members

HIGH +

Export

Enumeration Members

HIGH MAIN -

Enumeration Members

HIGH

HIGH: "HIGH"

MAIN

MAIN: "MAIN"

Settings

Member Visibility

Theme

On This Page

HIGHMAIN
\ No newline at end of file +

Enumeration Members

HIGH

HIGH: "HIGH"

MAIN

MAIN: "MAIN"

Settings

Member Visibility

Theme

On This Page

HIGHMAIN
\ No newline at end of file diff --git a/docs/enums/LevelH264.html b/docs/enums/LevelH264.html index c5c67ba0a..410c8c9ad 100644 --- a/docs/enums/LevelH264.html +++ b/docs/enums/LevelH264.html @@ -1,5 +1,5 @@ LevelH264 | @bitmovin/api-sdk

Enumeration LevelH264

Specified set of constraints that indicate a degree of required decoder performance for a profile, see: https://en.wikipedia.org/wiki/H.264/MPEG-4_AVC#Levels

-

Export

Enumeration Members

L1 +

Export

Enumeration Members

L1 L1_1 L1_2 L1_3 @@ -16,4 +16,4 @@ L5 L5_1 L5_2 -

Enumeration Members

L1

L1: "1"

L1_1

L1_1: "1.1"

L1_2

L1_2: "1.2"

L1_3

L1_3: "1.3"

L1b

L1b: "1b"

L2

L2: "2"

L2_1

L2_1: "2.1"

L2_2

L2_2: "2.2"

L3

L3: "3"

L3_1

L3_1: "3.1"

L3_2

L3_2: "3.2"

L4

L4: "4"

L4_1

L4_1: "4.1"

L4_2

L4_2: "4.2"

L5

L5: "5"

L5_1

L5_1: "5.1"

L5_2

L5_2: "5.2"

Settings

Member Visibility

Theme

On This Page

L1L1_1L1_2L1_3L1bL2L2_1L2_2L3L3_1L3_2L4L4_1L4_2L5L5_1L5_2
\ No newline at end of file +

Enumeration Members

L1

L1: "1"

L1_1

L1_1: "1.1"

L1_2

L1_2: "1.2"

L1_3

L1_3: "1.3"

L1b

L1b: "1b"

L2

L2: "2"

L2_1

L2_1: "2.1"

L2_2

L2_2: "2.2"

L3

L3: "3"

L3_1

L3_1: "3.1"

L3_2

L3_2: "3.2"

L4

L4: "4"

L4_1

L4_1: "4.1"

L4_2

L4_2: "4.2"

L5

L5: "5"

L5_1

L5_1: "5.1"

L5_2

L5_2: "5.2"

Settings

Member Visibility

Theme

On This Page

L1L1_1L1_2L1_3L1bL2L2_1L2_2L3L3_1L3_2L4L4_1L4_2L5L5_1L5_2
\ No newline at end of file diff --git a/docs/enums/LevelH265.html b/docs/enums/LevelH265.html index 68e2ad58c..0356df29a 100644 --- a/docs/enums/LevelH265.html +++ b/docs/enums/LevelH265.html @@ -1,5 +1,5 @@ LevelH265 | @bitmovin/api-sdk

Enumeration LevelH265

Specified set of constraints that indicate a degree of required decoder performance for a profile, see: https://en.wikipedia.org/wiki/High_Efficiency_Video_Coding_tiers_and_levels

-

Export

Enumeration Members

L1 +

Export

Enumeration Members

L1 L2 L2_1 L3 @@ -12,4 +12,4 @@ L6 L6_1 L6_2 -

Enumeration Members

L1

L1: "1"

L2

L2: "2"

L2_1

L2_1: "2.1"

L3

L3: "3"

L3_1

L3_1: "3.1"

L4

L4: "4"

L4_1

L4_1: "4.1"

L5

L5: "5"

L5_1

L5_1: "5.1"

L5_2

L5_2: "5.2"

L6

L6: "6"

L6_1

L6_1: "6.1"

L6_2

L6_2: "6.2"

Settings

Member Visibility

Theme

On This Page

L1L2L2_1L3L3_1L4L4_1L5L5_1L5_2L6L6_1L6_2
\ No newline at end of file +

Enumeration Members

L1

L1: "1"

L2

L2: "2"

L2_1

L2_1: "2.1"

L3

L3: "3"

L3_1

L3_1: "3.1"

L4

L4: "4"

L4_1

L4_1: "4.1"

L5

L5: "5"

L5_1

L5_1: "5.1"

L5_2

L5_2: "5.2"

L6

L6: "6"

L6_1

L6_1: "6.1"

L6_2

L6_2: "6.2"

Settings

Member Visibility

Theme

On This Page

L1L2L2_1L3L3_1L4L4_1L5L5_1L5_2L6L6_1L6_2
\ No newline at end of file diff --git a/docs/enums/LimitReferences.html b/docs/enums/LimitReferences.html index a4ae3c24b..707084c95 100644 --- a/docs/enums/LimitReferences.html +++ b/docs/enums/LimitReferences.html @@ -1,5 +1,5 @@ -LimitReferences | @bitmovin/api-sdk

Enumeration LimitReferences

Export

Enumeration Members

CU +LimitReferences | @bitmovin/api-sdk

Enumeration LimitReferences

Export

Enumeration Members

CU DEPTH DEPTH_AND_CU DISABLED -

Enumeration Members

CU

CU: "CU"

DEPTH

DEPTH: "DEPTH"

DEPTH_AND_CU

DEPTH_AND_CU: "DEPTH_AND_CU"

DISABLED

DISABLED: "DISABLED"

Settings

Member Visibility

Theme

On This Page

CUDEPTHDEPTH_AND_CUDISABLED
\ No newline at end of file +

Enumeration Members

CU

CU: "CU"

DEPTH

DEPTH: "DEPTH"

DEPTH_AND_CU

DEPTH_AND_CU: "DEPTH_AND_CU"

DISABLED

DISABLED: "DISABLED"

Settings

Member Visibility

Theme

On This Page

CUDEPTHDEPTH_AND_CUDISABLED
\ No newline at end of file diff --git a/docs/enums/LimitTransformUnitDepthRecursionMode.html b/docs/enums/LimitTransformUnitDepthRecursionMode.html index a59a52917..3ab16b6d8 100644 --- a/docs/enums/LimitTransformUnitDepthRecursionMode.html +++ b/docs/enums/LimitTransformUnitDepthRecursionMode.html @@ -1,7 +1,7 @@ LimitTransformUnitDepthRecursionMode | @bitmovin/api-sdk

Enumeration LimitTransformUnitDepthRecursionMode

Enables early exit from transform unit depth recursion, for inter coded blocks.

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED LEVEL_1 LEVEL_2 LEVEL_3 LEVEL_4 -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

LEVEL_1

LEVEL_1: "LEVEL_1"

LEVEL_2

LEVEL_2: "LEVEL_2"

LEVEL_3

LEVEL_3: "LEVEL_3"

LEVEL_4

LEVEL_4: "LEVEL_4"

Settings

Member Visibility

Theme

On This Page

DISABLEDLEVEL_1LEVEL_2LEVEL_3LEVEL_4
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

LEVEL_1

LEVEL_1: "LEVEL_1"

LEVEL_2

LEVEL_2: "LEVEL_2"

LEVEL_3

LEVEL_3: "LEVEL_3"

LEVEL_4

LEVEL_4: "LEVEL_4"

Settings

Member Visibility

Theme

On This Page

DISABLEDLEVEL_1LEVEL_2LEVEL_3LEVEL_4
\ No newline at end of file diff --git a/docs/enums/LiveEncodingCodec.html b/docs/enums/LiveEncodingCodec.html index 37ee2bb28..2d73059bb 100644 --- a/docs/enums/LiveEncodingCodec.html +++ b/docs/enums/LiveEncodingCodec.html @@ -1,4 +1,4 @@ -LiveEncodingCodec | @bitmovin/api-sdk

Enumeration LiveEncodingCodec

Export

Enumeration Members

AAC +LiveEncodingCodec | @bitmovin/api-sdk

Enumeration LiveEncodingCodec

Export

Enumeration Members

AAC H264 H265 -

Enumeration Members

AAC

AAC: "AAC"

H264

H264: "H264"

H265

H265: "H265"

Settings

Member Visibility

Theme

On This Page

AACH264H265
\ No newline at end of file +

Enumeration Members

AAC

AAC: "AAC"

H264

H264: "H264"

H265

H265: "H265"

Settings

Member Visibility

Theme

On This Page

AACH264H265
\ No newline at end of file diff --git a/docs/enums/LiveEncodingEventName.html b/docs/enums/LiveEncodingEventName.html index 363c90cbb..fc2a5f4b7 100644 --- a/docs/enums/LiveEncodingEventName.html +++ b/docs/enums/LiveEncodingEventName.html @@ -1,7 +1,7 @@ -LiveEncodingEventName | @bitmovin/api-sdk

Enumeration LiveEncodingEventName

Export

Enumeration Members

DISCONNECT +LiveEncodingEventName | @bitmovin/api-sdk

Enumeration LiveEncodingEventName

Export

Enumeration Members

DISCONNECT ERROR FIRST_CONNECT IDLE RECONNECT RESYNCING -

Enumeration Members

DISCONNECT

DISCONNECT: "DISCONNECT"

ERROR

ERROR: "ERROR"

FIRST_CONNECT

FIRST_CONNECT: "FIRST_CONNECT"

IDLE

IDLE: "IDLE"

RECONNECT

RECONNECT: "RECONNECT"

RESYNCING

RESYNCING: "RESYNCING"

Settings

Member Visibility

Theme

On This Page

DISCONNECTERRORFIRST_CONNECTIDLERECONNECTRESYNCING
\ No newline at end of file +

Enumeration Members

DISCONNECT

DISCONNECT: "DISCONNECT"

ERROR

ERROR: "ERROR"

FIRST_CONNECT

FIRST_CONNECT: "FIRST_CONNECT"

IDLE

IDLE: "IDLE"

RECONNECT

RECONNECT: "RECONNECT"

RESYNCING

RESYNCING: "RESYNCING"

Settings

Member Visibility

Theme

On This Page

DISCONNECTERRORFIRST_CONNECTIDLERECONNECTRESYNCING
\ No newline at end of file diff --git a/docs/enums/LiveEncodingStatus.html b/docs/enums/LiveEncodingStatus.html index 658782ac0..56abab22c 100644 --- a/docs/enums/LiveEncodingStatus.html +++ b/docs/enums/LiveEncodingStatus.html @@ -1,7 +1,7 @@ -LiveEncodingStatus | @bitmovin/api-sdk

Enumeration LiveEncodingStatus

Export

Enumeration Members

CONNECTED +LiveEncodingStatus | @bitmovin/api-sdk

Enumeration LiveEncodingStatus

Export

Enumeration Members

CONNECTED DISCONNECTED ERROR FINISHED NOT_AVAILABLE WAITING_FOR_FIRST_CONNECT -

Enumeration Members

CONNECTED

CONNECTED: "CONNECTED"

DISCONNECTED

DISCONNECTED: "DISCONNECTED"

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

NOT_AVAILABLE

NOT_AVAILABLE: "NOT_AVAILABLE"

WAITING_FOR_FIRST_CONNECT

WAITING_FOR_FIRST_CONNECT: "WAITING_FOR_FIRST_CONNECT"

Settings

Member Visibility

Theme

On This Page

CONNECTEDDISCONNECTEDERRORFINISHEDNOT_AVAILABLEWAITING_FOR_FIRST_CONNECT
\ No newline at end of file +

Enumeration Members

CONNECTED

CONNECTED: "CONNECTED"

DISCONNECTED

DISCONNECTED: "DISCONNECTED"

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

NOT_AVAILABLE

NOT_AVAILABLE: "NOT_AVAILABLE"

WAITING_FOR_FIRST_CONNECT

WAITING_FOR_FIRST_CONNECT: "WAITING_FOR_FIRST_CONNECT"

Settings

Member Visibility

Theme

On This Page

CONNECTEDDISCONNECTEDERRORFINISHEDNOT_AVAILABLEWAITING_FOR_FIRST_CONNECT
\ No newline at end of file diff --git a/docs/enums/LiveOptionsType.html b/docs/enums/LiveOptionsType.html index 35eaa5f11..d11e5080c 100644 --- a/docs/enums/LiveOptionsType.html +++ b/docs/enums/LiveOptionsType.html @@ -1,2 +1,2 @@ -LiveOptionsType | @bitmovin/api-sdk

Enumeration LiveOptionsType

Export

Enumeration Members

HD -

Enumeration Members

HD

HD: "HD"

Settings

Member Visibility

Theme

On This Page

HD
\ No newline at end of file +LiveOptionsType | @bitmovin/api-sdk

Enumeration LiveOptionsType

Export

Enumeration Members

HD +

Enumeration Members

HD

HD: "HD"

Settings

Member Visibility

Theme

On This Page

HD
\ No newline at end of file diff --git a/docs/enums/ManifestGenerator.html b/docs/enums/ManifestGenerator.html index 201855bf1..08275857e 100644 --- a/docs/enums/ManifestGenerator.html +++ b/docs/enums/ManifestGenerator.html @@ -1,3 +1,3 @@ -ManifestGenerator | @bitmovin/api-sdk

Enumeration ManifestGenerator

Export

Enumeration Members

LEGACY +ManifestGenerator | @bitmovin/api-sdk

Enumeration ManifestGenerator

Export

Enumeration Members

LEGACY V2 -

Enumeration Members

LEGACY

LEGACY: "LEGACY"

V2

V2: "V2"

Settings

Member Visibility

Theme

On This Page

LEGACYV2
\ No newline at end of file +

Enumeration Members

LEGACY

LEGACY: "LEGACY"

V2

V2: "V2"

Settings

Member Visibility

Theme

On This Page

LEGACYV2
\ No newline at end of file diff --git a/docs/enums/ManifestType.html b/docs/enums/ManifestType.html index 2020711e9..08c350e47 100644 --- a/docs/enums/ManifestType.html +++ b/docs/enums/ManifestType.html @@ -1,4 +1,4 @@ -ManifestType | @bitmovin/api-sdk

Enumeration ManifestType

Export

Enumeration Members

DASH +ManifestType | @bitmovin/api-sdk

Enumeration ManifestType

Export

Enumeration Members

DASH HLS SMOOTH_STREAMING -

Enumeration Members

DASH

DASH: "DASH"

HLS

HLS: "HLS"

SMOOTH_STREAMING

SMOOTH_STREAMING: "SMOOTH_STREAMING"

Settings

Member Visibility

Theme

On This Page

DASHHLSSMOOTH_STREAMING
\ No newline at end of file +

Enumeration Members

DASH

DASH: "DASH"

HLS

HLS: "HLS"

SMOOTH_STREAMING

SMOOTH_STREAMING: "SMOOTH_STREAMING"

Settings

Member Visibility

Theme

On This Page

DASHHLSSMOOTH_STREAMING
\ No newline at end of file diff --git a/docs/enums/Marketplace.html b/docs/enums/Marketplace.html index acb41669a..cfd541ace 100644 --- a/docs/enums/Marketplace.html +++ b/docs/enums/Marketplace.html @@ -1,4 +1,4 @@ Marketplace | @bitmovin/api-sdk

Enumeration Marketplace

Type of signup marketplace

-

Export

Enumeration Members

AWS +

Export

Enumeration Members

AWS AZURE -

Enumeration Members

AWS

AWS: "AWS"

AZURE

AZURE: "AZURE"

Settings

Member Visibility

Theme

On This Page

AWSAZURE
\ No newline at end of file +

Enumeration Members

AWS

AWS: "AWS"

AZURE

AZURE: "AZURE"

Settings

Member Visibility

Theme

On This Page

AWSAZURE
\ No newline at end of file diff --git a/docs/enums/MaxCtuSize.html b/docs/enums/MaxCtuSize.html index 39f95bdcb..6fc4d5b0b 100644 --- a/docs/enums/MaxCtuSize.html +++ b/docs/enums/MaxCtuSize.html @@ -1,5 +1,5 @@ MaxCtuSize | @bitmovin/api-sdk

Enumeration MaxCtuSize

Set the maximal CTU (Coding Tree Unit) size

-

Export

Enumeration Members

S16 +

Export

Enumeration Members

S16 S32 S64 -

Enumeration Members

S16

S16: "16"

S32

S32: "32"

S64

S64: "64"

Settings

Member Visibility

Theme

On This Page

S16S32S64
\ No newline at end of file +

Enumeration Members

S16

S16: "16"

S32

S32: "32"

S64

S64: "64"

Settings

Member Visibility

Theme

On This Page

S16S32S64
\ No newline at end of file diff --git a/docs/enums/MaxTransformUnitSize.html b/docs/enums/MaxTransformUnitSize.html index f7e59509c..bc2acaebe 100644 --- a/docs/enums/MaxTransformUnitSize.html +++ b/docs/enums/MaxTransformUnitSize.html @@ -1,5 +1,5 @@ -MaxTransformUnitSize | @bitmovin/api-sdk

Enumeration MaxTransformUnitSize

Export

Enumeration Members

MTU_16x16 +MaxTransformUnitSize | @bitmovin/api-sdk

Enumeration MaxTransformUnitSize

Export

Enumeration Members

MTU_16x16 MTU_32x32 MTU_4x4 MTU_8x8 -

Enumeration Members

MTU_16x16

MTU_16x16: "MTU_16x16"

MTU_32x32

MTU_32x32: "MTU_32x32"

MTU_4x4

MTU_4x4: "MTU_4x4"

MTU_8x8

MTU_8x8: "MTU_8x8"

Settings

Member Visibility

Theme

On This Page

MTU_16x16MTU_32x32MTU_4x4MTU_8x8
\ No newline at end of file +

Enumeration Members

MTU_16x16

MTU_16x16: "MTU_16x16"

MTU_32x32

MTU_32x32: "MTU_32x32"

MTU_4x4

MTU_4x4: "MTU_4x4"

MTU_8x8

MTU_8x8: "MTU_8x8"

Settings

Member Visibility

Theme

On This Page

MTU_16x16MTU_32x32MTU_4x4MTU_8x8
\ No newline at end of file diff --git a/docs/enums/MediaConfigBitrate.html b/docs/enums/MediaConfigBitrate.html index e5dd1a539..e368ab4b9 100644 --- a/docs/enums/MediaConfigBitrate.html +++ b/docs/enums/MediaConfigBitrate.html @@ -1,5 +1,5 @@ MediaConfigBitrate | @bitmovin/api-sdk

Enumeration MediaConfigBitrate

The supported bitrate

-

Export

Enumeration Members

MCB_160000 +

Export

Enumeration Members

MCB_160000 MCB_192000 MCB_224000 MCB_256000 @@ -7,4 +7,4 @@ MCB_320000 MCB_384000 MCB_448000 -

Enumeration Members

MCB_160000

MCB_160000: "160000"

MCB_192000

MCB_192000: "192000"

MCB_224000

MCB_224000: "224000"

MCB_256000

MCB_256000: "256000"

MCB_288000

MCB_288000: "288000"

MCB_320000

MCB_320000: "320000"

MCB_384000

MCB_384000: "384000"

MCB_448000

MCB_448000: "448000"

Settings

Member Visibility

Theme

On This Page

MCB_160000MCB_192000MCB_224000MCB_256000MCB_288000MCB_320000MCB_384000MCB_448000
\ No newline at end of file +

Enumeration Members

MCB_160000

MCB_160000: "160000"

MCB_192000

MCB_192000: "192000"

MCB_224000

MCB_224000: "224000"

MCB_256000

MCB_256000: "256000"

MCB_288000

MCB_288000: "288000"

MCB_320000

MCB_320000: "320000"

MCB_384000

MCB_384000: "384000"

MCB_448000

MCB_448000: "448000"

Settings

Member Visibility

Theme

On This Page

MCB_160000MCB_192000MCB_224000MCB_256000MCB_288000MCB_320000MCB_384000MCB_448000
\ No newline at end of file diff --git a/docs/enums/MediaInfoType.html b/docs/enums/MediaInfoType.html index 30551751b..7851cb4d7 100644 --- a/docs/enums/MediaInfoType.html +++ b/docs/enums/MediaInfoType.html @@ -1,6 +1,6 @@ -MediaInfoType | @bitmovin/api-sdk

Enumeration MediaInfoType

Export

Enumeration Members

AUDIO +MediaInfoType | @bitmovin/api-sdk

Enumeration MediaInfoType

Export

Enumeration Members

AUDIO CLOSED_CAPTIONS SUBTITLES VIDEO VTT -

Enumeration Members

AUDIO

AUDIO: "AUDIO"

CLOSED_CAPTIONS

CLOSED_CAPTIONS: "CLOSED_CAPTIONS"

SUBTITLES

SUBTITLES: "SUBTITLES"

VIDEO

VIDEO: "VIDEO"

VTT

VTT: "VTT"

Settings

Member Visibility

Theme

On This Page

AUDIOCLOSED_CAPTIONSSUBTITLESVIDEOVTT
\ No newline at end of file +

Enumeration Members

AUDIO

AUDIO: "AUDIO"

CLOSED_CAPTIONS

CLOSED_CAPTIONS: "CLOSED_CAPTIONS"

SUBTITLES

SUBTITLES: "SUBTITLES"

VIDEO

VIDEO: "VIDEO"

VTT

VTT: "VTT"

Settings

Member Visibility

Theme

On This Page

AUDIOCLOSED_CAPTIONSSUBTITLESVIDEOVTT
\ No newline at end of file diff --git a/docs/enums/MediaType.html b/docs/enums/MediaType.html index ca4bd022a..ca1859214 100644 --- a/docs/enums/MediaType.html +++ b/docs/enums/MediaType.html @@ -1,3 +1,3 @@ -MediaType | @bitmovin/api-sdk

Enumeration MediaType

Export

Enumeration Members

AUDIO +MediaType | @bitmovin/api-sdk

Enumeration MediaType

Export

Enumeration Members

AUDIO VIDEO -

Enumeration Members

AUDIO

AUDIO: "AUDIO"

VIDEO

VIDEO: "VIDEO"

Settings

Member Visibility

Theme

On This Page

AUDIOVIDEO
\ No newline at end of file +

Enumeration Members

AUDIO

AUDIO: "AUDIO"

VIDEO

VIDEO: "VIDEO"

Settings

Member Visibility

Theme

On This Page

AUDIOVIDEO
\ No newline at end of file diff --git a/docs/enums/MessageType.html b/docs/enums/MessageType.html index b42e74ef8..b74465dee 100644 --- a/docs/enums/MessageType.html +++ b/docs/enums/MessageType.html @@ -1,6 +1,6 @@ -MessageType | @bitmovin/api-sdk

Enumeration MessageType

Export

Enumeration Members

DEBUG +MessageType | @bitmovin/api-sdk

Enumeration MessageType

Export

Enumeration Members

DEBUG ERROR INFO TRACE WARNING -

Enumeration Members

DEBUG

DEBUG: "DEBUG"

ERROR

ERROR: "ERROR"

INFO

INFO: "INFO"

TRACE

TRACE: "TRACE"

WARNING

WARNING: "WARNING"

Settings

Member Visibility

Theme

On This Page

DEBUGERRORINFOTRACEWARNING
\ No newline at end of file +

Enumeration Members

DEBUG

DEBUG: "DEBUG"

ERROR

ERROR: "ERROR"

INFO

INFO: "INFO"

TRACE

TRACE: "TRACE"

WARNING

WARNING: "WARNING"

Settings

Member Visibility

Theme

On This Page

DEBUGERRORINFOTRACEWARNING
\ No newline at end of file diff --git a/docs/enums/MinCodingUnitSize.html b/docs/enums/MinCodingUnitSize.html index f9c9d6155..7b5584e9e 100644 --- a/docs/enums/MinCodingUnitSize.html +++ b/docs/enums/MinCodingUnitSize.html @@ -1,4 +1,4 @@ -MinCodingUnitSize | @bitmovin/api-sdk

Enumeration MinCodingUnitSize

Export

Enumeration Members

MCU_16x16 +MinCodingUnitSize | @bitmovin/api-sdk

Enumeration MinCodingUnitSize

Export

Enumeration Members

MCU_16x16 MCU_32x32 MCU_8x8 -

Enumeration Members

MCU_16x16

MCU_16x16: "MCU_16x16"

MCU_32x32

MCU_32x32: "MCU_32x32"

MCU_8x8

MCU_8x8: "MCU_8x8"

Settings

Member Visibility

Theme

On This Page

MCU_16x16MCU_32x32MCU_8x8
\ No newline at end of file +

Enumeration Members

MCU_16x16

MCU_16x16: "MCU_16x16"

MCU_32x32

MCU_32x32: "MCU_32x32"

MCU_8x8

MCU_8x8: "MCU_8x8"

Settings

Member Visibility

Theme

On This Page

MCU_16x16MCU_32x32MCU_8x8
\ No newline at end of file diff --git a/docs/enums/MotionSearch.html b/docs/enums/MotionSearch.html index e38c7f46c..bc852b0ab 100644 --- a/docs/enums/MotionSearch.html +++ b/docs/enums/MotionSearch.html @@ -1,7 +1,7 @@ MotionSearch | @bitmovin/api-sdk

Enumeration MotionSearch

Set the Motion search method

-

Export

Enumeration Members

DIA +

Export

Enumeration Members

DIA FULL HEX STAR UMH -

Enumeration Members

DIA

DIA: "DIA"

FULL

FULL: "FULL"

HEX

HEX: "HEX"

STAR

STAR: "STAR"

UMH

UMH: "UMH"

Settings

Member Visibility

Theme

On This Page

DIAFULLHEXSTARUMH
\ No newline at end of file +

Enumeration Members

DIA

DIA: "DIA"

FULL

FULL: "FULL"

HEX

HEX: "HEX"

STAR

STAR: "STAR"

UMH

UMH: "UMH"

Settings

Member Visibility

Theme

On This Page

DIAFULLHEXSTARUMH
\ No newline at end of file diff --git a/docs/enums/MuxingType.html b/docs/enums/MuxingType.html index c0b4b66ab..cc48c2620 100644 --- a/docs/enums/MuxingType.html +++ b/docs/enums/MuxingType.html @@ -1,4 +1,4 @@ -MuxingType | @bitmovin/api-sdk

Enumeration MuxingType

Export

Enumeration Members

BROADCAST_TS +MuxingType | @bitmovin/api-sdk

Enumeration MuxingType

Export

Enumeration Members

BROADCAST_TS CHUNKED_TEXT CMAF FMP4 @@ -13,4 +13,4 @@ TEXT TS WEBM -

Enumeration Members

BROADCAST_TS

BROADCAST_TS: "BROADCAST_TS"

CHUNKED_TEXT

CHUNKED_TEXT: "CHUNKED_TEXT"

CMAF

CMAF: "CMAF"

FMP4

FMP4: "FMP4"

MP3

MP3: "MP3"

MP4

MP4: "MP4"

MXF

MXF: "MXF"

PACKED_AUDIO

PACKED_AUDIO: "PACKED_AUDIO"

PROGRESSIVE_MOV

PROGRESSIVE_MOV: "PROGRESSIVE_MOV"

PROGRESSIVE_TS

PROGRESSIVE_TS: "PROGRESSIVE_TS"

PROGRESSIVE_WEBM

PROGRESSIVE_WEBM: "PROGRESSIVE_WEBM"

SEGMENTED_RAW

SEGMENTED_RAW: "SEGMENTED_RAW"

TEXT

TEXT: "TEXT"

TS

TS: "TS"

WEBM

WEBM: "WEBM"

Settings

Member Visibility

Theme

On This Page

BROADCAST_TSCHUNKED_TEXTCMAFFMP4MP3MP4MXFPACKED_AUDIOPROGRESSIVE_MOVPROGRESSIVE_TSPROGRESSIVE_WEBMSEGMENTED_RAWTEXTTSWEBM
\ No newline at end of file +

Enumeration Members

BROADCAST_TS

BROADCAST_TS: "BROADCAST_TS"

CHUNKED_TEXT

CHUNKED_TEXT: "CHUNKED_TEXT"

CMAF

CMAF: "CMAF"

FMP4

FMP4: "FMP4"

MP3

MP3: "MP3"

MP4

MP4: "MP4"

MXF

MXF: "MXF"

PACKED_AUDIO

PACKED_AUDIO: "PACKED_AUDIO"

PROGRESSIVE_MOV

PROGRESSIVE_MOV: "PROGRESSIVE_MOV"

PROGRESSIVE_TS

PROGRESSIVE_TS: "PROGRESSIVE_TS"

PROGRESSIVE_WEBM

PROGRESSIVE_WEBM: "PROGRESSIVE_WEBM"

SEGMENTED_RAW

SEGMENTED_RAW: "SEGMENTED_RAW"

TEXT

TEXT: "TEXT"

TS

TS: "TS"

WEBM

WEBM: "WEBM"

Settings

Member Visibility

Theme

On This Page

BROADCAST_TSCHUNKED_TEXTCMAFFMP4MP3MP4MXFPACKED_AUDIOPROGRESSIVE_MOVPROGRESSIVE_TSPROGRESSIVE_WEBMSEGMENTED_RAWTEXTTSWEBM
\ No newline at end of file diff --git a/docs/enums/MvPredictionMode.html b/docs/enums/MvPredictionMode.html index 45e6f20f5..aca3edee0 100644 --- a/docs/enums/MvPredictionMode.html +++ b/docs/enums/MvPredictionMode.html @@ -1,6 +1,6 @@ MvPredictionMode | @bitmovin/api-sdk

Enumeration MvPredictionMode

Motion vector prediction mode

-

Export

Enumeration Members

AUTO +

Export

Enumeration Members

AUTO NONE SPATIAL TEMPORAL -

Enumeration Members

AUTO

AUTO: "AUTO"

NONE

NONE: "NONE"

SPATIAL

SPATIAL: "SPATIAL"

TEMPORAL

TEMPORAL: "TEMPORAL"

Settings

Member Visibility

Theme

On This Page

AUTONONESPATIALTEMPORAL
\ No newline at end of file +

Enumeration Members

AUTO

AUTO: "AUTO"

NONE

NONE: "NONE"

SPATIAL

SPATIAL: "SPATIAL"

TEMPORAL

TEMPORAL: "TEMPORAL"

Settings

Member Visibility

Theme

On This Page

AUTONONESPATIALTEMPORAL
\ No newline at end of file diff --git a/docs/enums/NexGuardABWatermarkingFeature.html b/docs/enums/NexGuardABWatermarkingFeature.html index 8196c583b..9dbb5c677 100644 --- a/docs/enums/NexGuardABWatermarkingFeature.html +++ b/docs/enums/NexGuardABWatermarkingFeature.html @@ -1,3 +1,3 @@ -NexGuardABWatermarkingFeature | @bitmovin/api-sdk

Enumeration NexGuardABWatermarkingFeature

Export

Enumeration Members

DUPLICATED +NexGuardABWatermarkingFeature | @bitmovin/api-sdk

Enumeration NexGuardABWatermarkingFeature

Export

Enumeration Members

DUPLICATED OTT -

Enumeration Members

DUPLICATED

DUPLICATED: "DUPLICATED"

OTT

OTT: "OTT"

Settings

Member Visibility

Theme

On This Page

DUPLICATEDOTT
\ No newline at end of file +

Enumeration Members

DUPLICATED

DUPLICATED: "DUPLICATED"

OTT

OTT: "OTT"

Settings

Member Visibility

Theme

On This Page

DUPLICATEDOTT
\ No newline at end of file diff --git a/docs/enums/NexGuardWatermarkingStrength.html b/docs/enums/NexGuardWatermarkingStrength.html index 8de46efaf..161a1a05a 100644 --- a/docs/enums/NexGuardWatermarkingStrength.html +++ b/docs/enums/NexGuardWatermarkingStrength.html @@ -1,6 +1,6 @@ -NexGuardWatermarkingStrength | @bitmovin/api-sdk

Enumeration NexGuardWatermarkingStrength

Export

Enumeration Members

DEFAULT +NexGuardWatermarkingStrength | @bitmovin/api-sdk

Enumeration NexGuardWatermarkingStrength

Export

Enumeration Members

DEFAULT LIGHTER LIGHTEST STRONGER STRONGEST -

Enumeration Members

DEFAULT

DEFAULT: "DEFAULT"

LIGHTER

LIGHTER: "LIGHTER"

LIGHTEST

LIGHTEST: "LIGHTEST"

STRONGER

STRONGER: "STRONGER"

STRONGEST

STRONGEST: "STRONGEST"

Settings

Member Visibility

Theme

On This Page

DEFAULTLIGHTERLIGHTESTSTRONGERSTRONGEST
\ No newline at end of file +

Enumeration Members

DEFAULT

DEFAULT: "DEFAULT"

LIGHTER

LIGHTER: "LIGHTER"

LIGHTEST

LIGHTEST: "LIGHTEST"

STRONGER

STRONGER: "STRONGER"

STRONGEST

STRONGEST: "STRONGEST"

Settings

Member Visibility

Theme

On This Page

DEFAULTLIGHTERLIGHTESTSTRONGERSTRONGEST
\ No newline at end of file diff --git a/docs/enums/NexGuardWatermarkingType.html b/docs/enums/NexGuardWatermarkingType.html index 37437a9a7..59fe34d1f 100644 --- a/docs/enums/NexGuardWatermarkingType.html +++ b/docs/enums/NexGuardWatermarkingType.html @@ -1,3 +1,3 @@ -NexGuardWatermarkingType | @bitmovin/api-sdk

Enumeration NexGuardWatermarkingType

Export

Enumeration Members

DUPLICATED +NexGuardWatermarkingType | @bitmovin/api-sdk

Enumeration NexGuardWatermarkingType

Export

Enumeration Members

DUPLICATED OTT -

Enumeration Members

DUPLICATED

DUPLICATED: "DUPLICATED"

OTT

OTT: "OTT"

Settings

Member Visibility

Theme

On This Page

DUPLICATEDOTT
\ No newline at end of file +

Enumeration Members

DUPLICATED

DUPLICATED: "DUPLICATED"

OTT

OTT: "OTT"

Settings

Member Visibility

Theme

On This Page

DUPLICATEDOTT
\ No newline at end of file diff --git a/docs/enums/NotificationStates.html b/docs/enums/NotificationStates.html index e1061f484..b63fd7f0c 100644 --- a/docs/enums/NotificationStates.html +++ b/docs/enums/NotificationStates.html @@ -1,3 +1,3 @@ -NotificationStates | @bitmovin/api-sdk

Enumeration NotificationStates

Export

Enumeration Members

FIRED +NotificationStates | @bitmovin/api-sdk

Enumeration NotificationStates

Export

Enumeration Members

FIRED RESOLVED -

Enumeration Members

FIRED

FIRED: "FIRED"

RESOLVED

RESOLVED: "RESOLVED"

Settings

Member Visibility

Theme

On This Page

FIREDRESOLVED
\ No newline at end of file +

Enumeration Members

FIRED

FIRED: "FIRED"

RESOLVED

RESOLVED: "RESOLVED"

Settings

Member Visibility

Theme

On This Page

FIREDRESOLVED
\ No newline at end of file diff --git a/docs/enums/OpusChannelLayout.html b/docs/enums/OpusChannelLayout.html index c3c8b159e..880af40de 100644 --- a/docs/enums/OpusChannelLayout.html +++ b/docs/enums/OpusChannelLayout.html @@ -1,4 +1,4 @@ -OpusChannelLayout | @bitmovin/api-sdk

Enumeration OpusChannelLayout

Export

Enumeration Members

CL_4_1 +OpusChannelLayout | @bitmovin/api-sdk

Enumeration OpusChannelLayout

Export

Enumeration Members

CL_4_1 CL_5_0_BACK CL_6_1 CL_7_1 @@ -8,4 +8,4 @@ MONO NONE XCL_5_1_BACK -

Enumeration Members

CL_4_1

CL_4_1: "4.1"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_6_1

CL_6_1: "6.1"

CL_7_1

CL_7_1: "7.1"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

XCL_5_1_BACK

XCL_5_1_BACK: "5.1_BACK"

Settings

Member Visibility

Theme

On This Page

CL_4_1CL_5_0_BACKCL_6_1CL_7_1CL_QUADCL_STEREOCL_SURROUNDMONONONEXCL_5_1_BACK
\ No newline at end of file +

Enumeration Members

CL_4_1

CL_4_1: "4.1"

CL_5_0_BACK

CL_5_0_BACK: "5.0_BACK"

CL_6_1

CL_6_1: "6.1"

CL_7_1

CL_7_1: "7.1"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

XCL_5_1_BACK

XCL_5_1_BACK: "5.1_BACK"

Settings

Member Visibility

Theme

On This Page

CL_4_1CL_5_0_BACKCL_6_1CL_7_1CL_QUADCL_STEREOCL_SURROUNDMONONONEXCL_5_1_BACK
\ No newline at end of file diff --git a/docs/enums/OrganizationType.html b/docs/enums/OrganizationType.html index 947e43ae2..74552bf1f 100644 --- a/docs/enums/OrganizationType.html +++ b/docs/enums/OrganizationType.html @@ -1,3 +1,3 @@ -OrganizationType | @bitmovin/api-sdk

Enumeration OrganizationType

Export

Enumeration Members

ROOT_ORGANIZATION +OrganizationType | @bitmovin/api-sdk

Enumeration OrganizationType

Export

Enumeration Members

ROOT_ORGANIZATION SUB_ORGANIZATION -

Enumeration Members

ROOT_ORGANIZATION

ROOT_ORGANIZATION: "ROOT_ORGANIZATION"

SUB_ORGANIZATION

SUB_ORGANIZATION: "SUB_ORGANIZATION"

Settings

Member Visibility

Theme

On This Page

ROOT_ORGANIZATIONSUB_ORGANIZATION
\ No newline at end of file +

Enumeration Members

ROOT_ORGANIZATION

ROOT_ORGANIZATION: "ROOT_ORGANIZATION"

SUB_ORGANIZATION

SUB_ORGANIZATION: "SUB_ORGANIZATION"

Settings

Member Visibility

Theme

On This Page

ROOT_ORGANIZATIONSUB_ORGANIZATION
\ No newline at end of file diff --git a/docs/enums/OttLoudnessMode.html b/docs/enums/OttLoudnessMode.html index 681a20cfb..09f66fa28 100644 --- a/docs/enums/OttLoudnessMode.html +++ b/docs/enums/OttLoudnessMode.html @@ -1,5 +1,5 @@ OttLoudnessMode | @bitmovin/api-sdk

Enumeration OttLoudnessMode

Specifies the OTT loudness mode. If the mode is DTSX_OTT_LOUDNESS_DETECT, the lkfs value will be calculated internally and does not need to be provided. A provided lkfs value will be ignored. For the modes DTSX_OTT_LOUDNESS_INPUT and DTSX_OTT_LOUDNESS_TARGET an lkfs value must be provided by the user.

-

Export

Enumeration Members

DTSX_OTT_LOUDNESS_DETECT +

Export

Enumeration Members

DTSX_OTT_LOUDNESS_DETECT DTSX_OTT_LOUDNESS_INPUT DTSX_OTT_LOUDNESS_TARGET -

Enumeration Members

DTSX_OTT_LOUDNESS_DETECT

DTSX_OTT_LOUDNESS_DETECT: "DTSX_OTT_LOUDNESS_DETECT"

DTSX_OTT_LOUDNESS_INPUT

DTSX_OTT_LOUDNESS_INPUT: "DTSX_OTT_LOUDNESS_INPUT"

DTSX_OTT_LOUDNESS_TARGET

DTSX_OTT_LOUDNESS_TARGET: "DTSX_OTT_LOUDNESS_TARGET"

Settings

Member Visibility

Theme

On This Page

DTSX_OTT_LOUDNESS_DETECTDTSX_OTT_LOUDNESS_INPUTDTSX_OTT_LOUDNESS_TARGET
\ No newline at end of file +

Enumeration Members

DTSX_OTT_LOUDNESS_DETECT

DTSX_OTT_LOUDNESS_DETECT: "DTSX_OTT_LOUDNESS_DETECT"

DTSX_OTT_LOUDNESS_INPUT

DTSX_OTT_LOUDNESS_INPUT: "DTSX_OTT_LOUDNESS_INPUT"

DTSX_OTT_LOUDNESS_TARGET

DTSX_OTT_LOUDNESS_TARGET: "DTSX_OTT_LOUDNESS_TARGET"

Settings

Member Visibility

Theme

On This Page

DTSX_OTT_LOUDNESS_DETECTDTSX_OTT_LOUDNESS_INPUTDTSX_OTT_LOUDNESS_TARGET
\ No newline at end of file diff --git a/docs/enums/OutputType.html b/docs/enums/OutputType.html index c388e547e..985195a6c 100644 --- a/docs/enums/OutputType.html +++ b/docs/enums/OutputType.html @@ -1,4 +1,4 @@ -OutputType | @bitmovin/api-sdk

Enumeration OutputType

Export

Enumeration Members

AKAMAI_MSL +OutputType | @bitmovin/api-sdk

Enumeration OutputType

Export

Enumeration Members

AKAMAI_MSL AKAMAI_NETSTORAGE AZURE CDN @@ -11,4 +11,4 @@ S3 S3_ROLE_BASED SFTP -

Enumeration Members

AKAMAI_MSL

AKAMAI_MSL: "AKAMAI_MSL"

AKAMAI_NETSTORAGE

AKAMAI_NETSTORAGE: "AKAMAI_NETSTORAGE"

AZURE

AZURE: "AZURE"

CDN

CDN: "CDN"

FTP

FTP: "FTP"

GCS

GCS: "GCS"

GCS_SERVICE_ACCOUNT

GCS_SERVICE_ACCOUNT: "GCS_SERVICE_ACCOUNT"

GENERIC_S3

GENERIC_S3: "GENERIC_S3"

LIVE_MEDIA_INGEST

LIVE_MEDIA_INGEST: "LIVE_MEDIA_INGEST"

LOCAL

LOCAL: "LOCAL"

S3

S3: "S3"

S3_ROLE_BASED

S3_ROLE_BASED: "S3_ROLE_BASED"

SFTP

SFTP: "SFTP"

Settings

Member Visibility

Theme

On This Page

AKAMAI_MSLAKAMAI_NETSTORAGEAZURECDNFTPGCSGCS_SERVICE_ACCOUNTGENERIC_S3LIVE_MEDIA_INGESTLOCALS3S3_ROLE_BASEDSFTP
\ No newline at end of file +

Enumeration Members

AKAMAI_MSL

AKAMAI_MSL: "AKAMAI_MSL"

AKAMAI_NETSTORAGE

AKAMAI_NETSTORAGE: "AKAMAI_NETSTORAGE"

AZURE

AZURE: "AZURE"

CDN

CDN: "CDN"

FTP

FTP: "FTP"

GCS

GCS: "GCS"

GCS_SERVICE_ACCOUNT

GCS_SERVICE_ACCOUNT: "GCS_SERVICE_ACCOUNT"

GENERIC_S3

GENERIC_S3: "GENERIC_S3"

LIVE_MEDIA_INGEST

LIVE_MEDIA_INGEST: "LIVE_MEDIA_INGEST"

LOCAL

LOCAL: "LOCAL"

S3

S3: "S3"

S3_ROLE_BASED

S3_ROLE_BASED: "S3_ROLE_BASED"

SFTP

SFTP: "SFTP"

Settings

Member Visibility

Theme

On This Page

AKAMAI_MSLAKAMAI_NETSTORAGEAZURECDNFTPGCSGCS_SERVICE_ACCOUNTGENERIC_S3LIVE_MEDIA_INGESTLOCALS3S3_ROLE_BASEDSFTP
\ No newline at end of file diff --git a/docs/enums/PTSAlignMode.html b/docs/enums/PTSAlignMode.html index 5ee9e0758..d88d3daac 100644 --- a/docs/enums/PTSAlignMode.html +++ b/docs/enums/PTSAlignMode.html @@ -1,3 +1,3 @@ PTSAlignMode | @bitmovin/api-sdk

Enumeration PTSAlignMode

Alignmet mode for PTS

-

Export

Enumeration Members

ALIGN_ZERO_NEGATIVE_CTO -

Enumeration Members

ALIGN_ZERO_NEGATIVE_CTO

ALIGN_ZERO_NEGATIVE_CTO: "ALIGN_ZERO_NEGATIVE_CTO"

Settings

Member Visibility

Theme

On This Page

ALIGN_ZERO_NEGATIVE_CTO
\ No newline at end of file +

Export

Enumeration Members

ALIGN_ZERO_NEGATIVE_CTO +

Enumeration Members

ALIGN_ZERO_NEGATIVE_CTO

ALIGN_ZERO_NEGATIVE_CTO: "ALIGN_ZERO_NEGATIVE_CTO"

Settings

Member Visibility

Theme

On This Page

ALIGN_ZERO_NEGATIVE_CTO
\ No newline at end of file diff --git a/docs/enums/PaddingDurationUnit.html b/docs/enums/PaddingDurationUnit.html index 3570fbfe8..8d35bc7ba 100644 --- a/docs/enums/PaddingDurationUnit.html +++ b/docs/enums/PaddingDurationUnit.html @@ -1,3 +1,3 @@ -PaddingDurationUnit | @bitmovin/api-sdk

Enumeration PaddingDurationUnit

Export

Enumeration Members

FRAMES +PaddingDurationUnit | @bitmovin/api-sdk

Enumeration PaddingDurationUnit

Export

Enumeration Members

FRAMES SECONDS -

Enumeration Members

FRAMES

FRAMES: "FRAMES"

SECONDS

SECONDS: "SECONDS"

Settings

Member Visibility

Theme

On This Page

FRAMESSECONDS
\ No newline at end of file +

Enumeration Members

FRAMES

FRAMES: "FRAMES"

SECONDS

SECONDS: "SECONDS"

Settings

Member Visibility

Theme

On This Page

FRAMESSECONDS
\ No newline at end of file diff --git a/docs/enums/PassthroughMode.html b/docs/enums/PassthroughMode.html index 2eab0db58..77fa04439 100644 --- a/docs/enums/PassthroughMode.html +++ b/docs/enums/PassthroughMode.html @@ -1,5 +1,5 @@ PassthroughMode | @bitmovin/api-sdk

Enumeration PassthroughMode

Configure if the encoding should use the video stream as the passthrough mode or a dedicated caption stream.

-

Export

Enumeration Members

CAPTION_STREAM +

Export

Enumeration Members

CAPTION_STREAM VIDEO_CAPTION_STREAM VIDEO_STREAM -

Enumeration Members

CAPTION_STREAM

CAPTION_STREAM: "CAPTION_STREAM"

VIDEO_CAPTION_STREAM

VIDEO_CAPTION_STREAM: "VIDEO_CAPTION_STREAM"

VIDEO_STREAM

VIDEO_STREAM: "VIDEO_STREAM"

Settings

Member Visibility

Theme

On This Page

CAPTION_STREAMVIDEO_CAPTION_STREAMVIDEO_STREAM
\ No newline at end of file +

Enumeration Members

CAPTION_STREAM

CAPTION_STREAM: "CAPTION_STREAM"

VIDEO_CAPTION_STREAM

VIDEO_CAPTION_STREAM: "VIDEO_CAPTION_STREAM"

VIDEO_STREAM

VIDEO_STREAM: "VIDEO_STREAM"

Settings

Member Visibility

Theme

On This Page

CAPTION_STREAMVIDEO_CAPTION_STREAMVIDEO_STREAM
\ No newline at end of file diff --git a/docs/enums/PcmChannelLayout.html b/docs/enums/PcmChannelLayout.html index a8aa95e79..a5754d4c1 100644 --- a/docs/enums/PcmChannelLayout.html +++ b/docs/enums/PcmChannelLayout.html @@ -1,2 +1,2 @@ -PcmChannelLayout | @bitmovin/api-sdk

Enumeration PcmChannelLayout

Export

Enumeration Members

MONO -

Enumeration Members

MONO

MONO: "MONO"

Settings

Member Visibility

Theme

On This Page

MONO
\ No newline at end of file +PcmChannelLayout | @bitmovin/api-sdk

Enumeration PcmChannelLayout

Export

Enumeration Members

MONO +

Enumeration Members

MONO

MONO: "MONO"

Settings

Member Visibility

Theme

On This Page

MONO
\ No newline at end of file diff --git a/docs/enums/PcmPresetConfiguration.html b/docs/enums/PcmPresetConfiguration.html index 3c377d29f..0f30c20ce 100644 --- a/docs/enums/PcmPresetConfiguration.html +++ b/docs/enums/PcmPresetConfiguration.html @@ -1,2 +1,2 @@ -PcmPresetConfiguration | @bitmovin/api-sdk

Enumeration PcmPresetConfiguration

Export

Enumeration Members

XDCAM -

Enumeration Members

XDCAM

XDCAM: "XDCAM"

Settings

Member Visibility

Theme

On This Page

XDCAM
\ No newline at end of file +PcmPresetConfiguration | @bitmovin/api-sdk

Enumeration PcmPresetConfiguration

Export

Enumeration Members

XDCAM +

Enumeration Members

XDCAM

XDCAM: "XDCAM"

Settings

Member Visibility

Theme

On This Page

XDCAM
\ No newline at end of file diff --git a/docs/enums/PcmSampleFormat.html b/docs/enums/PcmSampleFormat.html index a8cd172e9..7bf3c37bb 100644 --- a/docs/enums/PcmSampleFormat.html +++ b/docs/enums/PcmSampleFormat.html @@ -1,3 +1,3 @@ -PcmSampleFormat | @bitmovin/api-sdk

Enumeration PcmSampleFormat

Export

Enumeration Members

S16LE +PcmSampleFormat | @bitmovin/api-sdk

Enumeration PcmSampleFormat

Export

Enumeration Members

S16LE S24LE -

Enumeration Members

S16LE

S16LE: "S16LE"

S24LE

S24LE: "S24LE"

Settings

Member Visibility

Theme

On This Page

S16LES24LE
\ No newline at end of file +

Enumeration Members

S16LE

S16LE: "S16LE"

S24LE

S24LE: "S24LE"

Settings

Member Visibility

Theme

On This Page

S16LES24LE
\ No newline at end of file diff --git a/docs/enums/PerTitleFixedResolutionAndBitrateConfigurationMode.html b/docs/enums/PerTitleFixedResolutionAndBitrateConfigurationMode.html index 8d21a3a15..027db37ed 100644 --- a/docs/enums/PerTitleFixedResolutionAndBitrateConfigurationMode.html +++ b/docs/enums/PerTitleFixedResolutionAndBitrateConfigurationMode.html @@ -1,5 +1,5 @@ -PerTitleFixedResolutionAndBitrateConfigurationMode | @bitmovin/api-sdk

Enumeration PerTitleFixedResolutionAndBitrateConfigurationMode

Export

Enumeration Members

AVERAGE +PerTitleFixedResolutionAndBitrateConfigurationMode | @bitmovin/api-sdk

Enumeration PerTitleFixedResolutionAndBitrateConfigurationMode

Export

Enumeration Members

AVERAGE LAST_CALCULATED_BITRATE MAXIMUM MINIMUM -

Enumeration Members

AVERAGE

AVERAGE: "AVERAGE"

LAST_CALCULATED_BITRATE

LAST_CALCULATED_BITRATE: "LAST_CALCULATED_BITRATE"

MAXIMUM

MAXIMUM: "MAXIMUM"

MINIMUM

MINIMUM: "MINIMUM"

Settings

Member Visibility

Theme

On This Page

AVERAGELAST_CALCULATED_BITRATEMAXIMUMMINIMUM
\ No newline at end of file +

Enumeration Members

AVERAGE

AVERAGE: "AVERAGE"

LAST_CALCULATED_BITRATE

LAST_CALCULATED_BITRATE: "LAST_CALCULATED_BITRATE"

MAXIMUM

MAXIMUM: "MAXIMUM"

MINIMUM

MINIMUM: "MINIMUM"

Settings

Member Visibility

Theme

On This Page

AVERAGELAST_CALCULATED_BITRATEMAXIMUMMINIMUM
\ No newline at end of file diff --git a/docs/enums/Permission.html b/docs/enums/Permission.html index 371a0d37e..7ee967a56 100644 --- a/docs/enums/Permission.html +++ b/docs/enums/Permission.html @@ -1,7 +1,7 @@ Permission | @bitmovin/api-sdk

Enumeration Permission

Permission to assign.

-

Export

Enumeration Members

DELETE +

Export

Enumeration Members

DELETE GET PATCH POST PUT -

Enumeration Members

DELETE

DELETE: "DELETE"

GET

GET: "GET"

PATCH

PATCH: "PATCH"

POST

POST: "POST"

PUT

PUT: "PUT"

Settings

Member Visibility

Theme

On This Page

DELETEGETPATCHPOSTPUT
\ No newline at end of file +

Enumeration Members

DELETE

DELETE: "DELETE"

GET

GET: "GET"

PATCH

PATCH: "PATCH"

POST

POST: "POST"

PUT

PUT: "PUT"

Settings

Member Visibility

Theme

On This Page

DELETEGETPATCHPOSTPUT
\ No newline at end of file diff --git a/docs/enums/PictureFieldParity.html b/docs/enums/PictureFieldParity.html index 3ff66030c..28c7e8777 100644 --- a/docs/enums/PictureFieldParity.html +++ b/docs/enums/PictureFieldParity.html @@ -1,5 +1,5 @@ PictureFieldParity | @bitmovin/api-sdk

Enumeration PictureFieldParity

Specifies which field of an interlaced frame is assumed to be the first one

-

Export

Enumeration Members

AUTO +

Export

Enumeration Members

AUTO BOTTOM_FIELD_FIRST TOP_FIELD_FIRST -

Enumeration Members

AUTO

AUTO: "AUTO"

BOTTOM_FIELD_FIRST

BOTTOM_FIELD_FIRST: "BOTTOM_FIELD_FIRST"

TOP_FIELD_FIRST

TOP_FIELD_FIRST: "TOP_FIELD_FIRST"

Settings

Member Visibility

Theme

On This Page

AUTOBOTTOM_FIELD_FIRSTTOP_FIELD_FIRST
\ No newline at end of file +

Enumeration Members

AUTO

AUTO: "AUTO"

BOTTOM_FIELD_FIRST

BOTTOM_FIELD_FIRST: "BOTTOM_FIELD_FIRST"

TOP_FIELD_FIRST

TOP_FIELD_FIRST: "TOP_FIELD_FIRST"

Settings

Member Visibility

Theme

On This Page

AUTOBOTTOM_FIELD_FIRSTTOP_FIELD_FIRST
\ No newline at end of file diff --git a/docs/enums/PixelFormat.html b/docs/enums/PixelFormat.html index 3b86b926f..34cb9ac55 100644 --- a/docs/enums/PixelFormat.html +++ b/docs/enums/PixelFormat.html @@ -1,5 +1,5 @@ PixelFormat | @bitmovin/api-sdk

Enumeration PixelFormat

The pixel format to be set

-

Export

Enumeration Members

YUV410P +

Export

Enumeration Members

YUV410P YUV411P YUV420P YUV420P10BE @@ -26,4 +26,4 @@ YUVJ422P YUVJ440P YUVJ444P -

Enumeration Members

YUV410P

YUV410P: "YUV410P"

YUV411P

YUV411P: "YUV411P"

YUV420P

YUV420P: "YUV420P"

YUV420P10BE

YUV420P10BE: "YUV420P10BE"

YUV420P10LE

YUV420P10LE: "YUV420P10LE"

YUV420P12BE

YUV420P12BE: "YUV420P12BE"

YUV420P12LE

YUV420P12LE: "YUV420P12LE"

YUV422P

YUV422P: "YUV422P"

YUV422P10BE

YUV422P10BE: "YUV422P10BE"

YUV422P10LE

YUV422P10LE: "YUV422P10LE"

YUV422P12BE

YUV422P12BE: "YUV422P12BE"

YUV422P12LE

YUV422P12LE: "YUV422P12LE"

YUV440P

YUV440P: "YUV440P"

YUV440P10BE

YUV440P10BE: "YUV440P10BE"

YUV440P10LE

YUV440P10LE: "YUV440P10LE"

YUV440P12BE

YUV440P12BE: "YUV440P12BE"

YUV440P12LE

YUV440P12LE: "YUV440P12LE"

YUV444P

YUV444P: "YUV444P"

YUV444P10BE

YUV444P10BE: "YUV444P10BE"

YUV444P10LE

YUV444P10LE: "YUV444P10LE"

YUV444P12BE

YUV444P12BE: "YUV444P12BE"

YUV444P12LE

YUV444P12LE: "YUV444P12LE"

YUVJ411P

YUVJ411P: "YUVJ411P"

YUVJ420P

YUVJ420P: "YUVJ420P"

YUVJ422P

YUVJ422P: "YUVJ422P"

YUVJ440P

YUVJ440P: "YUVJ440P"

YUVJ444P

YUVJ444P: "YUVJ444P"

Settings

Member Visibility

Theme

On This Page

YUV410PYUV411PYUV420PYUV420P10BEYUV420P10LEYUV420P12BEYUV420P12LEYUV422PYUV422P10BEYUV422P10LEYUV422P12BEYUV422P12LEYUV440PYUV440P10BEYUV440P10LEYUV440P12BEYUV440P12LEYUV444PYUV444P10BEYUV444P10LEYUV444P12BEYUV444P12LEYUVJ411PYUVJ420PYUVJ422PYUVJ440PYUVJ444P
\ No newline at end of file +

Enumeration Members

YUV410P

YUV410P: "YUV410P"

YUV411P

YUV411P: "YUV411P"

YUV420P

YUV420P: "YUV420P"

YUV420P10BE

YUV420P10BE: "YUV420P10BE"

YUV420P10LE

YUV420P10LE: "YUV420P10LE"

YUV420P12BE

YUV420P12BE: "YUV420P12BE"

YUV420P12LE

YUV420P12LE: "YUV420P12LE"

YUV422P

YUV422P: "YUV422P"

YUV422P10BE

YUV422P10BE: "YUV422P10BE"

YUV422P10LE

YUV422P10LE: "YUV422P10LE"

YUV422P12BE

YUV422P12BE: "YUV422P12BE"

YUV422P12LE

YUV422P12LE: "YUV422P12LE"

YUV440P

YUV440P: "YUV440P"

YUV440P10BE

YUV440P10BE: "YUV440P10BE"

YUV440P10LE

YUV440P10LE: "YUV440P10LE"

YUV440P12BE

YUV440P12BE: "YUV440P12BE"

YUV440P12LE

YUV440P12LE: "YUV440P12LE"

YUV444P

YUV444P: "YUV444P"

YUV444P10BE

YUV444P10BE: "YUV444P10BE"

YUV444P10LE

YUV444P10LE: "YUV444P10LE"

YUV444P12BE

YUV444P12BE: "YUV444P12BE"

YUV444P12LE

YUV444P12LE: "YUV444P12LE"

YUVJ411P

YUVJ411P: "YUVJ411P"

YUVJ420P

YUVJ420P: "YUVJ420P"

YUVJ422P

YUVJ422P: "YUVJ422P"

YUVJ440P

YUVJ440P: "YUVJ440P"

YUVJ444P

YUVJ444P: "YUVJ444P"

Settings

Member Visibility

Theme

On This Page

YUV410PYUV411PYUV420PYUV420P10BEYUV420P10LEYUV420P12BEYUV420P12LEYUV422PYUV422P10BEYUV422P10LEYUV422P12BEYUV422P12LEYUV440PYUV440P10BEYUV440P10LEYUV440P12BEYUV440P12LEYUV444PYUV444P10BEYUV444P10LEYUV444P12BEYUV444P12LEYUVJ411PYUVJ420PYUVJ422PYUVJ440PYUVJ444P
\ No newline at end of file diff --git a/docs/enums/PixelFormatBitDepth.html b/docs/enums/PixelFormatBitDepth.html index ec2bd9eb4..8f6b2f85a 100644 --- a/docs/enums/PixelFormatBitDepth.html +++ b/docs/enums/PixelFormatBitDepth.html @@ -1,3 +1,3 @@ -PixelFormatBitDepth | @bitmovin/api-sdk

Enumeration PixelFormatBitDepth

Export

Enumeration Members

EIGHT_BIT +PixelFormatBitDepth | @bitmovin/api-sdk

Enumeration PixelFormatBitDepth

Export

Enumeration Members

EIGHT_BIT TEN_BIT -

Enumeration Members

EIGHT_BIT

EIGHT_BIT: "EIGHT_BIT"

TEN_BIT

TEN_BIT: "TEN_BIT"

Settings

Member Visibility

Theme

On This Page

EIGHT_BITTEN_BIT
\ No newline at end of file +

Enumeration Members

EIGHT_BIT

EIGHT_BIT: "EIGHT_BIT"

TEN_BIT

TEN_BIT: "TEN_BIT"

Settings

Member Visibility

Theme

On This Page

EIGHT_BITTEN_BIT
\ No newline at end of file diff --git a/docs/enums/PlayReadyEncryptionMethod.html b/docs/enums/PlayReadyEncryptionMethod.html index 33edd45e0..95e7f8123 100644 --- a/docs/enums/PlayReadyEncryptionMethod.html +++ b/docs/enums/PlayReadyEncryptionMethod.html @@ -1,4 +1,4 @@ PlayReadyEncryptionMethod | @bitmovin/api-sdk

Enumeration PlayReadyEncryptionMethod

Encryption method

-

Export

Enumeration Members

MPEG_CENC +

Export

Enumeration Members

MPEG_CENC PIFF_CTR -

Enumeration Members

MPEG_CENC

MPEG_CENC: "MPEG_CENC"

PIFF_CTR

PIFF_CTR: "PIFF_CTR"

Settings

Member Visibility

Theme

On This Page

MPEG_CENCPIFF_CTR
\ No newline at end of file +

Enumeration Members

MPEG_CENC

MPEG_CENC: "MPEG_CENC"

PIFF_CTR

PIFF_CTR: "PIFF_CTR"

Settings

Member Visibility

Theme

On This Page

MPEG_CENCPIFF_CTR
\ No newline at end of file diff --git a/docs/enums/PlayerThirdPartyLicensingErrorAction.html b/docs/enums/PlayerThirdPartyLicensingErrorAction.html index 4ce2e907c..9128d6596 100644 --- a/docs/enums/PlayerThirdPartyLicensingErrorAction.html +++ b/docs/enums/PlayerThirdPartyLicensingErrorAction.html @@ -1,3 +1,3 @@ -PlayerThirdPartyLicensingErrorAction | @bitmovin/api-sdk

Enumeration PlayerThirdPartyLicensingErrorAction

Export

Enumeration Members

ALLOW +PlayerThirdPartyLicensingErrorAction | @bitmovin/api-sdk

Enumeration PlayerThirdPartyLicensingErrorAction

Export

Enumeration Members

ALLOW DENY -

Enumeration Members

ALLOW

ALLOW: "ALLOW"

DENY

DENY: "DENY"

Settings

Member Visibility

Theme

On This Page

ALLOWDENY
\ No newline at end of file +

Enumeration Members

ALLOW

ALLOW: "ALLOW"

DENY

DENY: "DENY"

Settings

Member Visibility

Theme

On This Page

ALLOWDENY
\ No newline at end of file diff --git a/docs/enums/Policy.html b/docs/enums/Policy.html index 59d1b1a2b..3b8c27c56 100644 --- a/docs/enums/Policy.html +++ b/docs/enums/Policy.html @@ -1,4 +1,4 @@ Policy | @bitmovin/api-sdk

Enumeration Policy

The policy for the permissions.

-

Export

Enumeration Members

ALLOW +

Export

Enumeration Members

ALLOW DENY -

Enumeration Members

ALLOW

ALLOW: "ALLOW"

DENY

DENY: "DENY"

Settings

Member Visibility

Theme

On This Page

ALLOWDENY
\ No newline at end of file +

Enumeration Members

ALLOW

ALLOW: "ALLOW"

DENY

DENY: "DENY"

Settings

Member Visibility

Theme

On This Page

ALLOWDENY
\ No newline at end of file diff --git a/docs/enums/PositionMode.html b/docs/enums/PositionMode.html index b3411be0d..f9663e7ae 100644 --- a/docs/enums/PositionMode.html +++ b/docs/enums/PositionMode.html @@ -1,4 +1,4 @@ -PositionMode | @bitmovin/api-sdk

Enumeration PositionMode

Export

Enumeration Members

KEYFRAME +PositionMode | @bitmovin/api-sdk

Enumeration PositionMode

Export

Enumeration Members

KEYFRAME SEGMENT TIME -

Enumeration Members

KEYFRAME

KEYFRAME: "KEYFRAME"

SEGMENT

SEGMENT: "SEGMENT"

TIME

TIME: "TIME"

Settings

Member Visibility

Theme

On This Page

KEYFRAMESEGMENTTIME
\ No newline at end of file +

Enumeration Members

KEYFRAME

KEYFRAME: "KEYFRAME"

SEGMENT

SEGMENT: "SEGMENT"

TIME

TIME: "TIME"

Settings

Member Visibility

Theme

On This Page

KEYFRAMESEGMENTTIME
\ No newline at end of file diff --git a/docs/enums/PositionUnit.html b/docs/enums/PositionUnit.html index ede11405d..c0502d17a 100644 --- a/docs/enums/PositionUnit.html +++ b/docs/enums/PositionUnit.html @@ -1,3 +1,3 @@ -PositionUnit | @bitmovin/api-sdk

Enumeration PositionUnit

Export

Enumeration Members

PERCENTS +PositionUnit | @bitmovin/api-sdk

Enumeration PositionUnit

Export

Enumeration Members

PERCENTS PIXELS -

Enumeration Members

PERCENTS

PERCENTS: "PERCENTS"

PIXELS

PIXELS: "PIXELS"

Settings

Member Visibility

Theme

On This Page

PERCENTSPIXELS
\ No newline at end of file +

Enumeration Members

PERCENTS

PERCENTS: "PERCENTS"

PIXELS

PIXELS: "PIXELS"

Settings

Member Visibility

Theme

On This Page

PERCENTSPIXELS
\ No newline at end of file diff --git a/docs/enums/PresetConfiguration.html b/docs/enums/PresetConfiguration.html index f41bce657..2072995c6 100644 --- a/docs/enums/PresetConfiguration.html +++ b/docs/enums/PresetConfiguration.html @@ -1,4 +1,4 @@ -PresetConfiguration | @bitmovin/api-sdk

Enumeration PresetConfiguration

Export

Enumeration Members

LIVE_HIGH_QUALITY +PresetConfiguration | @bitmovin/api-sdk

Enumeration PresetConfiguration

Export

Enumeration Members

LIVE_HIGH_QUALITY LIVE_LOWER_LATENCY LIVE_LOW_LATENCY LIVE_STANDARD @@ -15,4 +15,4 @@ VOD_SUPERHIGH_SPEED VOD_ULTRAHIGH_SPEED VOD_VERYHIGH_SPEED -

Enumeration Members

LIVE_HIGH_QUALITY

LIVE_HIGH_QUALITY: "LIVE_HIGH_QUALITY"

LIVE_LOWER_LATENCY

LIVE_LOWER_LATENCY: "LIVE_LOWER_LATENCY"

LIVE_LOW_LATENCY

LIVE_LOW_LATENCY: "LIVE_LOW_LATENCY"

LIVE_STANDARD

LIVE_STANDARD: "LIVE_STANDARD"

LIVE_ULTRAHIGH_QUALITY

LIVE_ULTRAHIGH_QUALITY: "LIVE_ULTRAHIGH_QUALITY"

LIVE_VERYHIGH_QUALITY

LIVE_VERYHIGH_QUALITY: "LIVE_VERYHIGH_QUALITY"

LIVE_VERYLOW_LATENCY

LIVE_VERYLOW_LATENCY: "LIVE_VERYLOW_LATENCY"

VOD_EXTRAHIGH_SPEED

VOD_EXTRAHIGH_SPEED: "VOD_EXTRAHIGH_SPEED"

VOD_HARDWARE_SHORTFORM

VOD_HARDWARE_SHORTFORM: "VOD_HARDWARE_SHORTFORM"

VOD_HIGH_QUALITY

VOD_HIGH_QUALITY: "VOD_HIGH_QUALITY"

VOD_HIGH_SPEED

VOD_HIGH_SPEED: "VOD_HIGH_SPEED"

VOD_QUALITY

VOD_QUALITY: "VOD_QUALITY"

VOD_SPEED

VOD_SPEED: "VOD_SPEED"

VOD_STANDARD

VOD_STANDARD: "VOD_STANDARD"

VOD_SUPERHIGH_SPEED

VOD_SUPERHIGH_SPEED: "VOD_SUPERHIGH_SPEED"

VOD_ULTRAHIGH_SPEED

VOD_ULTRAHIGH_SPEED: "VOD_ULTRAHIGH_SPEED"

VOD_VERYHIGH_SPEED

VOD_VERYHIGH_SPEED: "VOD_VERYHIGH_SPEED"

Settings

Member Visibility

Theme

On This Page

LIVE_HIGH_QUALITYLIVE_LOWER_LATENCYLIVE_LOW_LATENCYLIVE_STANDARDLIVE_ULTRAHIGH_QUALITYLIVE_VERYHIGH_QUALITYLIVE_VERYLOW_LATENCYVOD_EXTRAHIGH_SPEEDVOD_HARDWARE_SHORTFORMVOD_HIGH_QUALITYVOD_HIGH_SPEEDVOD_QUALITYVOD_SPEEDVOD_STANDARDVOD_SUPERHIGH_SPEEDVOD_ULTRAHIGH_SPEEDVOD_VERYHIGH_SPEED
\ No newline at end of file +

Enumeration Members

LIVE_HIGH_QUALITY

LIVE_HIGH_QUALITY: "LIVE_HIGH_QUALITY"

LIVE_LOWER_LATENCY

LIVE_LOWER_LATENCY: "LIVE_LOWER_LATENCY"

LIVE_LOW_LATENCY

LIVE_LOW_LATENCY: "LIVE_LOW_LATENCY"

LIVE_STANDARD

LIVE_STANDARD: "LIVE_STANDARD"

LIVE_ULTRAHIGH_QUALITY

LIVE_ULTRAHIGH_QUALITY: "LIVE_ULTRAHIGH_QUALITY"

LIVE_VERYHIGH_QUALITY

LIVE_VERYHIGH_QUALITY: "LIVE_VERYHIGH_QUALITY"

LIVE_VERYLOW_LATENCY

LIVE_VERYLOW_LATENCY: "LIVE_VERYLOW_LATENCY"

VOD_EXTRAHIGH_SPEED

VOD_EXTRAHIGH_SPEED: "VOD_EXTRAHIGH_SPEED"

VOD_HARDWARE_SHORTFORM

VOD_HARDWARE_SHORTFORM: "VOD_HARDWARE_SHORTFORM"

VOD_HIGH_QUALITY

VOD_HIGH_QUALITY: "VOD_HIGH_QUALITY"

VOD_HIGH_SPEED

VOD_HIGH_SPEED: "VOD_HIGH_SPEED"

VOD_QUALITY

VOD_QUALITY: "VOD_QUALITY"

VOD_SPEED

VOD_SPEED: "VOD_SPEED"

VOD_STANDARD

VOD_STANDARD: "VOD_STANDARD"

VOD_SUPERHIGH_SPEED

VOD_SUPERHIGH_SPEED: "VOD_SUPERHIGH_SPEED"

VOD_ULTRAHIGH_SPEED

VOD_ULTRAHIGH_SPEED: "VOD_ULTRAHIGH_SPEED"

VOD_VERYHIGH_SPEED

VOD_VERYHIGH_SPEED: "VOD_VERYHIGH_SPEED"

Settings

Member Visibility

Theme

On This Page

LIVE_HIGH_QUALITYLIVE_LOWER_LATENCYLIVE_LOW_LATENCYLIVE_STANDARDLIVE_ULTRAHIGH_QUALITYLIVE_VERYHIGH_QUALITYLIVE_VERYLOW_LATENCYVOD_EXTRAHIGH_SPEEDVOD_HARDWARE_SHORTFORMVOD_HIGH_QUALITYVOD_HIGH_SPEEDVOD_QUALITYVOD_SPEEDVOD_STANDARDVOD_SUPERHIGH_SPEEDVOD_ULTRAHIGH_SPEEDVOD_VERYHIGH_SPEED
\ No newline at end of file diff --git a/docs/enums/PrewarmedEncoderDiskSize.html b/docs/enums/PrewarmedEncoderDiskSize.html index dbad74335..1f9302ff6 100644 --- a/docs/enums/PrewarmedEncoderDiskSize.html +++ b/docs/enums/PrewarmedEncoderDiskSize.html @@ -1,4 +1,4 @@ -PrewarmedEncoderDiskSize | @bitmovin/api-sdk

Enumeration PrewarmedEncoderDiskSize

Export

Enumeration Members

GB_1000 +PrewarmedEncoderDiskSize | @bitmovin/api-sdk

Enumeration PrewarmedEncoderDiskSize

Export

Enumeration Members

GB_1000 GB_2000 GB_500 -

Enumeration Members

GB_1000

GB_1000: "1000"

GB_2000

GB_2000: "2000"

GB_500

GB_500: "500"

Settings

Member Visibility

Theme

On This Page

GB_1000GB_2000GB_500
\ No newline at end of file +

Enumeration Members

GB_1000

GB_1000: "1000"

GB_2000

GB_2000: "2000"

GB_500

GB_500: "500"

Settings

Member Visibility

Theme

On This Page

GB_1000GB_2000GB_500
\ No newline at end of file diff --git a/docs/enums/PrewarmedEncoderPoolAction.html b/docs/enums/PrewarmedEncoderPoolAction.html index 5bf5aedd0..326a2e292 100644 --- a/docs/enums/PrewarmedEncoderPoolAction.html +++ b/docs/enums/PrewarmedEncoderPoolAction.html @@ -1,3 +1,3 @@ -PrewarmedEncoderPoolAction | @bitmovin/api-sdk

Enumeration PrewarmedEncoderPoolAction

Export

Enumeration Members

START +PrewarmedEncoderPoolAction | @bitmovin/api-sdk

Enumeration PrewarmedEncoderPoolAction

Export

Enumeration Members

START STOP -

Enumeration Members

START

START: "START"

STOP

STOP: "STOP"

Settings

Member Visibility

Theme

On This Page

STARTSTOP
\ No newline at end of file +

Enumeration Members

START

START: "START"

STOP

STOP: "STOP"

Settings

Member Visibility

Theme

On This Page

STARTSTOP
\ No newline at end of file diff --git a/docs/enums/PrewarmedEncoderPoolStatus.html b/docs/enums/PrewarmedEncoderPoolStatus.html index 30c27f4e7..933e86cf6 100644 --- a/docs/enums/PrewarmedEncoderPoolStatus.html +++ b/docs/enums/PrewarmedEncoderPoolStatus.html @@ -1,3 +1,3 @@ -PrewarmedEncoderPoolStatus | @bitmovin/api-sdk

Enumeration PrewarmedEncoderPoolStatus

Export

Enumeration Members

STARTED +PrewarmedEncoderPoolStatus | @bitmovin/api-sdk

Enumeration PrewarmedEncoderPoolStatus

Export

Enumeration Members

STARTED STOPPED -

Enumeration Members

STARTED

STARTED: "STARTED"

STOPPED

STOPPED: "STOPPED"

Settings

Member Visibility

Theme

On This Page

STARTEDSTOPPED
\ No newline at end of file +

Enumeration Members

STARTED

STARTED: "STARTED"

STOPPED

STOPPED: "STOPPED"

Settings

Member Visibility

Theme

On This Page

STARTEDSTOPPED
\ No newline at end of file diff --git a/docs/enums/ProfileH262.html b/docs/enums/ProfileH262.html index 2dc14360c..b2a0094cd 100644 --- a/docs/enums/ProfileH262.html +++ b/docs/enums/ProfileH262.html @@ -1,2 +1,2 @@ -ProfileH262 | @bitmovin/api-sdk

Enumeration ProfileH262

Export

Enumeration Members

MPEG2_422 -

Enumeration Members

MPEG2_422

MPEG2_422: "MPEG2_422"

Settings

Member Visibility

Theme

On This Page

MPEG2_422
\ No newline at end of file +ProfileH262 | @bitmovin/api-sdk

Enumeration ProfileH262

Export

Enumeration Members

MPEG2_422 +

Enumeration Members

MPEG2_422

MPEG2_422: "MPEG2_422"

Settings

Member Visibility

Theme

On This Page

MPEG2_422
\ No newline at end of file diff --git a/docs/enums/ProfileH264.html b/docs/enums/ProfileH264.html index b6a5874db..c437c1c01 100644 --- a/docs/enums/ProfileH264.html +++ b/docs/enums/ProfileH264.html @@ -1,5 +1,5 @@ -ProfileH264 | @bitmovin/api-sdk

Enumeration ProfileH264

Export

Enumeration Members

BASELINE +ProfileH264 | @bitmovin/api-sdk

Enumeration ProfileH264

Export

Enumeration Members

BASELINE HIGH HIGH422 MAIN -

Enumeration Members

BASELINE

BASELINE: "BASELINE"

HIGH

HIGH: "HIGH"

HIGH422

HIGH422: "HIGH422"

MAIN

MAIN: "MAIN"

Settings

Member Visibility

Theme

On This Page

BASELINEHIGHHIGH422MAIN
\ No newline at end of file +

Enumeration Members

BASELINE

BASELINE: "BASELINE"

HIGH

HIGH: "HIGH"

HIGH422

HIGH422: "HIGH422"

MAIN

MAIN: "MAIN"

Settings

Member Visibility

Theme

On This Page

BASELINEHIGHHIGH422MAIN
\ No newline at end of file diff --git a/docs/enums/ProfileH265.html b/docs/enums/ProfileH265.html index 4aa9d5cb8..1595768f5 100644 --- a/docs/enums/ProfileH265.html +++ b/docs/enums/ProfileH265.html @@ -1,3 +1,3 @@ -ProfileH265 | @bitmovin/api-sdk

Enumeration ProfileH265

Export

Enumeration Members

MAIN +ProfileH265 | @bitmovin/api-sdk

Enumeration ProfileH265

Export

Enumeration Members

MAIN MAIN10 -

Enumeration Members

MAIN

MAIN: "main"

MAIN10

MAIN10: "main10"

Settings

Member Visibility

Theme

On This Page

MAINMAIN10
\ No newline at end of file +

Enumeration Members

MAIN

MAIN: "main"

MAIN10

MAIN10: "main10"

Settings

Member Visibility

Theme

On This Page

MAINMAIN10
\ No newline at end of file diff --git a/docs/enums/ProgramDateTimeSource.html b/docs/enums/ProgramDateTimeSource.html index aaeafac16..ed203b385 100644 --- a/docs/enums/ProgramDateTimeSource.html +++ b/docs/enums/ProgramDateTimeSource.html @@ -1,4 +1,4 @@ ProgramDateTimeSource | @bitmovin/api-sdk

Enumeration ProgramDateTimeSource

Source for the EXT-X-PROGRAM-DATETIME tag

-

Export

Enumeration Members

EMBEDDED +

Export

Enumeration Members

EMBEDDED SYSTEM_CLOCK -

Enumeration Members

EMBEDDED

EMBEDDED: "EMBEDDED"

SYSTEM_CLOCK

SYSTEM_CLOCK: "SYSTEM_CLOCK"

Settings

Member Visibility

Theme

On This Page

EMBEDDEDSYSTEM_CLOCK
\ No newline at end of file +

Enumeration Members

EMBEDDED

EMBEDDED: "EMBEDDED"

SYSTEM_CLOCK

SYSTEM_CLOCK: "SYSTEM_CLOCK"

Settings

Member Visibility

Theme

On This Page

EMBEDDEDSYSTEM_CLOCK
\ No newline at end of file diff --git a/docs/enums/ProgressiveWebmMuxingManifestType.html b/docs/enums/ProgressiveWebmMuxingManifestType.html index 347cf6c5b..f6ddbdb38 100644 --- a/docs/enums/ProgressiveWebmMuxingManifestType.html +++ b/docs/enums/ProgressiveWebmMuxingManifestType.html @@ -1,4 +1,4 @@ ProgressiveWebmMuxingManifestType | @bitmovin/api-sdk

Enumeration ProgressiveWebmMuxingManifestType

Specifies the manifest type which will be allowed for the ProgressiveWebmMuxingManifestType Muxing.

-

Export

Enumeration Members

DASH_ON_DEMAND +

Export

Enumeration Members

DASH_ON_DEMAND NONE -

Enumeration Members

DASH_ON_DEMAND

DASH_ON_DEMAND: "DASH_ON_DEMAND"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

DASH_ON_DEMANDNONE
\ No newline at end of file +

Enumeration Members

DASH_ON_DEMAND

DASH_ON_DEMAND: "DASH_ON_DEMAND"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

DASH_ON_DEMANDNONE
\ No newline at end of file diff --git a/docs/enums/PsnrPerStreamMode.html b/docs/enums/PsnrPerStreamMode.html index 8373b00aa..56d3f9bec 100644 --- a/docs/enums/PsnrPerStreamMode.html +++ b/docs/enums/PsnrPerStreamMode.html @@ -1,3 +1,3 @@ -PsnrPerStreamMode | @bitmovin/api-sdk

Enumeration PsnrPerStreamMode

Export

Enumeration Members

DISABLED +PsnrPerStreamMode | @bitmovin/api-sdk

Enumeration PsnrPerStreamMode

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/QuantizationGroupSize.html b/docs/enums/QuantizationGroupSize.html index 61e2e4c01..dd6d25079 100644 --- a/docs/enums/QuantizationGroupSize.html +++ b/docs/enums/QuantizationGroupSize.html @@ -1,6 +1,6 @@ QuantizationGroupSize | @bitmovin/api-sdk

Enumeration QuantizationGroupSize

Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted.

-

Export

Enumeration Members

QGS_16x16 +

Export

Enumeration Members

QGS_16x16 QGS_32x32 QGS_64x64 QGS_8x8 -

Enumeration Members

QGS_16x16

QGS_16x16: "QGS_16x16"

QGS_32x32

QGS_32x32: "QGS_32x32"

QGS_64x64

QGS_64x64: "QGS_64x64"

QGS_8x8

QGS_8x8: "QGS_8x8"

Settings

Member Visibility

Theme

On This Page

QGS_16x16QGS_32x32QGS_64x64QGS_8x8
\ No newline at end of file +

Enumeration Members

QGS_16x16

QGS_16x16: "QGS_16x16"

QGS_32x32

QGS_32x32: "QGS_32x32"

QGS_64x64

QGS_64x64: "QGS_64x64"

QGS_8x8

QGS_8x8: "QGS_8x8"

Settings

Member Visibility

Theme

On This Page

QGS_16x16QGS_32x32QGS_64x64QGS_8x8
\ No newline at end of file diff --git a/docs/enums/RaiUnit.html b/docs/enums/RaiUnit.html index b3271a085..3781c87af 100644 --- a/docs/enums/RaiUnit.html +++ b/docs/enums/RaiUnit.html @@ -1,6 +1,6 @@ RaiUnit | @bitmovin/api-sdk

Enumeration RaiUnit

Set the random access indicator (RAI) on appropriate access units (AUs).

-

Export

Enumeration Members

ACCORDING_TO_INPUT +

Export

Enumeration Members

ACCORDING_TO_INPUT ACQUISITION_POINT_PACKETS ALL_PES_PACKETS NONE -

Enumeration Members

ACCORDING_TO_INPUT

ACCORDING_TO_INPUT: "ACCORDING_TO_INPUT"

ACQUISITION_POINT_PACKETS

ACQUISITION_POINT_PACKETS: "ACQUISITION_POINT_PACKETS"

ALL_PES_PACKETS

ALL_PES_PACKETS: "ALL_PES_PACKETS"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

ACCORDING_TO_INPUTACQUISITION_POINT_PACKETSALL_PES_PACKETSNONE
\ No newline at end of file +

Enumeration Members

ACCORDING_TO_INPUT

ACCORDING_TO_INPUT: "ACCORDING_TO_INPUT"

ACQUISITION_POINT_PACKETS

ACQUISITION_POINT_PACKETS: "ACQUISITION_POINT_PACKETS"

ALL_PES_PACKETS

ALL_PES_PACKETS: "ALL_PES_PACKETS"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

ACCORDING_TO_INPUTACQUISITION_POINT_PACKETSALL_PES_PACKETSNONE
\ No newline at end of file diff --git a/docs/enums/RateDistortionLevelForQuantization.html b/docs/enums/RateDistortionLevelForQuantization.html index afce26435..7a4d68aca 100644 --- a/docs/enums/RateDistortionLevelForQuantization.html +++ b/docs/enums/RateDistortionLevelForQuantization.html @@ -1,4 +1,4 @@ -RateDistortionLevelForQuantization | @bitmovin/api-sdk

Enumeration RateDistortionLevelForQuantization

Export

Enumeration Members

DISABLED +RateDistortionLevelForQuantization | @bitmovin/api-sdk

Enumeration RateDistortionLevelForQuantization

Export

Enumeration Members

DISABLED LEVELS LEVELS_AND_CODING_GROUPS -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

LEVELS

LEVELS: "LEVELS"

LEVELS_AND_CODING_GROUPS

LEVELS_AND_CODING_GROUPS: "LEVELS_AND_CODING_GROUPS"

Settings

Member Visibility

Theme

On This Page

DISABLEDLEVELSLEVELS_AND_CODING_GROUPS
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

LEVELS

LEVELS: "LEVELS"

LEVELS_AND_CODING_GROUPS

LEVELS_AND_CODING_GROUPS: "LEVELS_AND_CODING_GROUPS"

Settings

Member Visibility

Theme

On This Page

DISABLEDLEVELSLEVELS_AND_CODING_GROUPS
\ No newline at end of file diff --git a/docs/enums/RateDistortionPenaltyMode.html b/docs/enums/RateDistortionPenaltyMode.html index 5dc1530cd..b3d0e828f 100644 --- a/docs/enums/RateDistortionPenaltyMode.html +++ b/docs/enums/RateDistortionPenaltyMode.html @@ -1,5 +1,5 @@ RateDistortionPenaltyMode | @bitmovin/api-sdk

Enumeration RateDistortionPenaltyMode

Penalty for 32x32 intra transfer units in non-I slices.

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED MAXIMUM NORMAL -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

MAXIMUM

MAXIMUM: "MAXIMUM"

NORMAL

NORMAL: "NORMAL"

Settings

Member Visibility

Theme

On This Page

DISABLEDMAXIMUMNORMAL
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

MAXIMUM

MAXIMUM: "MAXIMUM"

NORMAL

NORMAL: "NORMAL"

Settings

Member Visibility

Theme

On This Page

DISABLEDMAXIMUMNORMAL
\ No newline at end of file diff --git a/docs/enums/ResourceType.html b/docs/enums/ResourceType.html index 010154a71..a19c38193 100644 --- a/docs/enums/ResourceType.html +++ b/docs/enums/ResourceType.html @@ -1,5 +1,5 @@ -ResourceType | @bitmovin/api-sdk

Enumeration ResourceType

Export

Enumeration Members

ACCOUNT +ResourceType | @bitmovin/api-sdk

Enumeration ResourceType

Export

Enumeration Members

ACCOUNT ANALYTICS ENCODING PLAYER -

Enumeration Members

ACCOUNT

ACCOUNT: "account"

ANALYTICS

ANALYTICS: "analytics"

ENCODING

ENCODING: "encoding"

PLAYER

PLAYER: "player"

Settings

Member Visibility

Theme

On This Page

ACCOUNTANALYTICSENCODINGPLAYER
\ No newline at end of file +

Enumeration Members

ACCOUNT

ACCOUNT: "account"

ANALYTICS

ANALYTICS: "analytics"

ENCODING

ENCODING: "encoding"

PLAYER

PLAYER: "player"

Settings

Member Visibility

Theme

On This Page

ACCOUNTANALYTICSENCODINGPLAYER
\ No newline at end of file diff --git a/docs/enums/ResponseStatus.html b/docs/enums/ResponseStatus.html index 0f58ead0e..0346092d5 100644 --- a/docs/enums/ResponseStatus.html +++ b/docs/enums/ResponseStatus.html @@ -1,3 +1,3 @@ -ResponseStatus | @bitmovin/api-sdk

Enumeration ResponseStatus

Export

Enumeration Members

ERROR +ResponseStatus | @bitmovin/api-sdk

Enumeration ResponseStatus

Export

Enumeration Members

ERROR SUCCESS -

Enumeration Members

ERROR

ERROR: "ERROR"

SUCCESS

SUCCESS: "SUCCESS"

Settings

Member Visibility

Theme

On This Page

ERRORSUCCESS
\ No newline at end of file +

Enumeration Members

ERROR

ERROR: "ERROR"

SUCCESS

SUCCESS: "SUCCESS"

Settings

Member Visibility

Theme

On This Page

ERRORSUCCESS
\ No newline at end of file diff --git a/docs/enums/RetryHint.html b/docs/enums/RetryHint.html index e3de116ed..58a75f194 100644 --- a/docs/enums/RetryHint.html +++ b/docs/enums/RetryHint.html @@ -1,5 +1,5 @@ -RetryHint | @bitmovin/api-sdk

Enumeration RetryHint

Export

Enumeration Members

NO_RETRY +RetryHint | @bitmovin/api-sdk

Enumeration RetryHint

Export

Enumeration Members

NO_RETRY RETRY RETRY_IN_DIFFERENT_REGION UNDEFINED -

Enumeration Members

NO_RETRY

NO_RETRY: "NO_RETRY"

RETRY

RETRY: "RETRY"

RETRY_IN_DIFFERENT_REGION

RETRY_IN_DIFFERENT_REGION: "RETRY_IN_DIFFERENT_REGION"

UNDEFINED

UNDEFINED: "UNDEFINED"

Settings

Member Visibility

Theme

On This Page

NO_RETRYRETRYRETRY_IN_DIFFERENT_REGIONUNDEFINED
\ No newline at end of file +

Enumeration Members

NO_RETRY

NO_RETRY: "NO_RETRY"

RETRY

RETRY: "RETRY"

RETRY_IN_DIFFERENT_REGION

RETRY_IN_DIFFERENT_REGION: "RETRY_IN_DIFFERENT_REGION"

UNDEFINED

UNDEFINED: "UNDEFINED"

Settings

Member Visibility

Theme

On This Page

NO_RETRYRETRYRETRY_IN_DIFFERENT_REGIONUNDEFINED
\ No newline at end of file diff --git a/docs/enums/S3AccessStyle.html b/docs/enums/S3AccessStyle.html index 46f5ef3f7..d236b3c7e 100644 --- a/docs/enums/S3AccessStyle.html +++ b/docs/enums/S3AccessStyle.html @@ -1,4 +1,4 @@ S3AccessStyle | @bitmovin/api-sdk

Enumeration S3AccessStyle

Specifies whether to use path or virtual-hosted style access

-

Export

Enumeration Members

PATH +

Export

Enumeration Members

PATH VIRTUAL_HOSTED -

Enumeration Members

PATH

PATH: "PATH"

VIRTUAL_HOSTED

VIRTUAL_HOSTED: "VIRTUAL_HOSTED"

Settings

Member Visibility

Theme

On This Page

PATHVIRTUAL_HOSTED
\ No newline at end of file +

Enumeration Members

PATH

PATH: "PATH"

VIRTUAL_HOSTED

VIRTUAL_HOSTED: "VIRTUAL_HOSTED"

Settings

Member Visibility

Theme

On This Page

PATHVIRTUAL_HOSTED
\ No newline at end of file diff --git a/docs/enums/S3SignatureVersion.html b/docs/enums/S3SignatureVersion.html index 2d4f4dea9..798d81611 100644 --- a/docs/enums/S3SignatureVersion.html +++ b/docs/enums/S3SignatureVersion.html @@ -1,3 +1,3 @@ -S3SignatureVersion | @bitmovin/api-sdk

Enumeration S3SignatureVersion

Export

Enumeration Members

V2 +S3SignatureVersion | @bitmovin/api-sdk

Enumeration S3SignatureVersion

Export

Enumeration Members

V2 V4 -

Enumeration Members

V2

V2: "S3_V2"

V4

V4: "S3_V4"

Settings

Member Visibility

Theme

On This Page

V2V4
\ No newline at end of file +

Enumeration Members

V2

V2: "S3_V2"

V4

V4: "S3_V4"

Settings

Member Visibility

Theme

On This Page

V2V4
\ No newline at end of file diff --git a/docs/enums/ScalingAlgorithm.html b/docs/enums/ScalingAlgorithm.html index 7ac94c005..4e9e38bdf 100644 --- a/docs/enums/ScalingAlgorithm.html +++ b/docs/enums/ScalingAlgorithm.html @@ -1,5 +1,5 @@ ScalingAlgorithm | @bitmovin/api-sdk

Enumeration ScalingAlgorithm

Determines the algorithm used for scaling

-

Export

Enumeration Members

AVERAGING_AREA +

Export

Enumeration Members

AVERAGING_AREA BICUBIC BICUBIC_LUMA_BILINEAR_CHROMA BILINEAR @@ -10,4 +10,4 @@ NEAREST_NEIGHBOR SINC SPLINE -

Enumeration Members

AVERAGING_AREA

AVERAGING_AREA: "AVERAGING_AREA"

BICUBIC

BICUBIC: "BICUBIC"

BICUBIC_LUMA_BILINEAR_CHROMA

BICUBIC_LUMA_BILINEAR_CHROMA: "BICUBIC_LUMA_BILINEAR_CHROMA"

BILINEAR

BILINEAR: "BILINEAR"

EXPERIMENTAL

EXPERIMENTAL: "EXPERIMENTAL"

FAST_BILINEAR

FAST_BILINEAR: "FAST_BILINEAR"

GAUSS

GAUSS: "GAUSS"

LANCZOS

LANCZOS: "LANCZOS"

NEAREST_NEIGHBOR

NEAREST_NEIGHBOR: "NEAREST_NEIGHBOR"

SINC

SINC: "SINC"

SPLINE

SPLINE: "SPLINE"

Settings

Member Visibility

Theme

On This Page

AVERAGING_AREABICUBICBICUBIC_LUMA_BILINEAR_CHROMABILINEAREXPERIMENTALFAST_BILINEARGAUSSLANCZOSNEAREST_NEIGHBORSINCSPLINE
\ No newline at end of file +

Enumeration Members

AVERAGING_AREA

AVERAGING_AREA: "AVERAGING_AREA"

BICUBIC

BICUBIC: "BICUBIC"

BICUBIC_LUMA_BILINEAR_CHROMA

BICUBIC_LUMA_BILINEAR_CHROMA: "BICUBIC_LUMA_BILINEAR_CHROMA"

BILINEAR

BILINEAR: "BILINEAR"

EXPERIMENTAL

EXPERIMENTAL: "EXPERIMENTAL"

FAST_BILINEAR

FAST_BILINEAR: "FAST_BILINEAR"

GAUSS

GAUSS: "GAUSS"

LANCZOS

LANCZOS: "LANCZOS"

NEAREST_NEIGHBOR

NEAREST_NEIGHBOR: "NEAREST_NEIGHBOR"

SINC

SINC: "SINC"

SPLINE

SPLINE: "SPLINE"

Settings

Member Visibility

Theme

On This Page

AVERAGING_AREABICUBICBICUBIC_LUMA_BILINEAR_CHROMABILINEAREXPERIMENTALFAST_BILINEARGAUSSLANCZOSNEAREST_NEIGHBORSINCSPLINE
\ No newline at end of file diff --git a/docs/enums/ScheduledInsertableContentStatus.html b/docs/enums/ScheduledInsertableContentStatus.html index 6567b2223..a4b74e11c 100644 --- a/docs/enums/ScheduledInsertableContentStatus.html +++ b/docs/enums/ScheduledInsertableContentStatus.html @@ -1,6 +1,6 @@ -ScheduledInsertableContentStatus | @bitmovin/api-sdk

Enumeration ScheduledInsertableContentStatus

Export

Enumeration Members

CREATED +ScheduledInsertableContentStatus | @bitmovin/api-sdk

Enumeration ScheduledInsertableContentStatus

Export

Enumeration Members

CREATED DESCHEDULED ERROR SCHEDULED TO_BE_DESCHEDULED -

Enumeration Members

CREATED

CREATED: "CREATED"

DESCHEDULED

DESCHEDULED: "DESCHEDULED"

ERROR

ERROR: "ERROR"

SCHEDULED

SCHEDULED: "SCHEDULED"

TO_BE_DESCHEDULED

TO_BE_DESCHEDULED: "TO_BE_DESCHEDULED"

Settings

Member Visibility

Theme

On This Page

CREATEDDESCHEDULEDERRORSCHEDULEDTO_BE_DESCHEDULED
\ No newline at end of file +

Enumeration Members

CREATED

CREATED: "CREATED"

DESCHEDULED

DESCHEDULED: "DESCHEDULED"

ERROR

ERROR: "ERROR"

SCHEDULED

SCHEDULED: "SCHEDULED"

TO_BE_DESCHEDULED

TO_BE_DESCHEDULED: "TO_BE_DESCHEDULED"

Settings

Member Visibility

Theme

On This Page

CREATEDDESCHEDULEDERRORSCHEDULEDTO_BE_DESCHEDULED
\ No newline at end of file diff --git a/docs/enums/SidecarErrorMode.html b/docs/enums/SidecarErrorMode.html index e27272ec9..88bcbe335 100644 --- a/docs/enums/SidecarErrorMode.html +++ b/docs/enums/SidecarErrorMode.html @@ -1,3 +1,3 @@ -SidecarErrorMode | @bitmovin/api-sdk

Enumeration SidecarErrorMode

Export

Enumeration Members

CONTINUE_ON_ERROR +SidecarErrorMode | @bitmovin/api-sdk

Enumeration SidecarErrorMode

Export

Enumeration Members

CONTINUE_ON_ERROR FAIL_ON_ERROR -

Enumeration Members

CONTINUE_ON_ERROR

CONTINUE_ON_ERROR: "CONTINUE_ON_ERROR"

FAIL_ON_ERROR

FAIL_ON_ERROR: "FAIL_ON_ERROR"

Settings

Member Visibility

Theme

On This Page

CONTINUE_ON_ERRORFAIL_ON_ERROR
\ No newline at end of file +

Enumeration Members

CONTINUE_ON_ERROR

CONTINUE_ON_ERROR: "CONTINUE_ON_ERROR"

FAIL_ON_ERROR

FAIL_ON_ERROR: "FAIL_ON_ERROR"

Settings

Member Visibility

Theme

On This Page

CONTINUE_ON_ERRORFAIL_ON_ERROR
\ No newline at end of file diff --git a/docs/enums/SidecarFileType.html b/docs/enums/SidecarFileType.html index 8fec69ba2..390d158a1 100644 --- a/docs/enums/SidecarFileType.html +++ b/docs/enums/SidecarFileType.html @@ -1,2 +1,2 @@ -SidecarFileType | @bitmovin/api-sdk

Enumeration SidecarFileType

Export

Enumeration Members

WEB_VTT -

Enumeration Members

WEB_VTT

WEB_VTT: "WEB_VTT"

Settings

Member Visibility

Theme

On This Page

WEB_VTT
\ No newline at end of file +SidecarFileType | @bitmovin/api-sdk

Enumeration SidecarFileType

Export

Enumeration Members

WEB_VTT +

Enumeration Members

WEB_VTT

WEB_VTT: "WEB_VTT"

Settings

Member Visibility

Theme

On This Page

WEB_VTT
\ No newline at end of file diff --git a/docs/enums/SignatureType.html b/docs/enums/SignatureType.html index d6ec4ffb3..ee76900ec 100644 --- a/docs/enums/SignatureType.html +++ b/docs/enums/SignatureType.html @@ -1,2 +1,2 @@ -SignatureType | @bitmovin/api-sdk

Enumeration SignatureType

Export

Enumeration Members

HMAC -

Enumeration Members

HMAC

HMAC: "HMAC"

Settings

Member Visibility

Theme

On This Page

HMAC
\ No newline at end of file +SignatureType | @bitmovin/api-sdk

Enumeration SignatureType

Export

Enumeration Members

HMAC +

Enumeration Members

HMAC

HMAC: "HMAC"

Settings

Member Visibility

Theme

On This Page

HMAC
\ No newline at end of file diff --git a/docs/enums/SignupSource.html b/docs/enums/SignupSource.html index d76edf424..21601b637 100644 --- a/docs/enums/SignupSource.html +++ b/docs/enums/SignupSource.html @@ -1,6 +1,6 @@ SignupSource | @bitmovin/api-sdk

Enumeration SignupSource

platform which initiated the creation of the resource

-

Export

Enumeration Members

AWS +

Export

Enumeration Members

AWS AZURE BITMOVIN GOOGLE -

Enumeration Members

AWS

AWS: "AWS"

AZURE

AZURE: "AZURE"

BITMOVIN

BITMOVIN: "BITMOVIN"

GOOGLE

GOOGLE: "GOOGLE"

Settings

Member Visibility

Theme

On This Page

AWSAZUREBITMOVINGOOGLE
\ No newline at end of file +

Enumeration Members

AWS

AWS: "AWS"

AZURE

AZURE: "AZURE"

BITMOVIN

BITMOVIN: "BITMOVIN"

GOOGLE

GOOGLE: "GOOGLE"

Settings

Member Visibility

Theme

On This Page

AWSAZUREBITMOVINGOOGLE
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingLiveCloudRegion.html b/docs/enums/SimpleEncodingLiveCloudRegion.html index 29be652b6..ca4ca77cd 100644 --- a/docs/enums/SimpleEncodingLiveCloudRegion.html +++ b/docs/enums/SimpleEncodingLiveCloudRegion.html @@ -1,7 +1,7 @@ -SimpleEncodingLiveCloudRegion | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveCloudRegion

Export

Enumeration Members

AFRICA +SimpleEncodingLiveCloudRegion | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveCloudRegion

Export

Enumeration Members

AFRICA ASIA AUSTRALIA EUROPE NORTH_AMERICA SOUTH_AMERICA -

Enumeration Members

AFRICA

AFRICA: "AFRICA"

ASIA

ASIA: "ASIA"

AUSTRALIA

AUSTRALIA: "AUSTRALIA"

EUROPE

EUROPE: "EUROPE"

NORTH_AMERICA

NORTH_AMERICA: "NORTH_AMERICA"

SOUTH_AMERICA

SOUTH_AMERICA: "SOUTH_AMERICA"

Settings

Member Visibility

Theme

On This Page

AFRICAASIAAUSTRALIAEUROPENORTH_AMERICASOUTH_AMERICA
\ No newline at end of file +

Enumeration Members

AFRICA

AFRICA: "AFRICA"

ASIA

ASIA: "ASIA"

AUSTRALIA

AUSTRALIA: "AUSTRALIA"

EUROPE

EUROPE: "EUROPE"

NORTH_AMERICA

NORTH_AMERICA: "NORTH_AMERICA"

SOUTH_AMERICA

SOUTH_AMERICA: "SOUTH_AMERICA"

Settings

Member Visibility

Theme

On This Page

AFRICAASIAAUSTRALIAEUROPENORTH_AMERICASOUTH_AMERICA
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingLiveJobInputType.html b/docs/enums/SimpleEncodingLiveJobInputType.html index 0401f3882..6c6f1a6b4 100644 --- a/docs/enums/SimpleEncodingLiveJobInputType.html +++ b/docs/enums/SimpleEncodingLiveJobInputType.html @@ -1,3 +1,3 @@ -SimpleEncodingLiveJobInputType | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveJobInputType

Export

Enumeration Members

RTMP +SimpleEncodingLiveJobInputType | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveJobInputType

Export

Enumeration Members

RTMP SRT_LISTENER -

Enumeration Members

RTMP

RTMP: "RTMP"

SRT_LISTENER

SRT_LISTENER: "SRT_LISTENER"

Settings

Member Visibility

Theme

On This Page

RTMPSRT_LISTENER
\ No newline at end of file +

Enumeration Members

RTMP

RTMP: "RTMP"

SRT_LISTENER

SRT_LISTENER: "SRT_LISTENER"

Settings

Member Visibility

Theme

On This Page

RTMPSRT_LISTENER
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingLiveJobOutputType.html b/docs/enums/SimpleEncodingLiveJobOutputType.html index 1d2ef5ed0..b61704a4d 100644 --- a/docs/enums/SimpleEncodingLiveJobOutputType.html +++ b/docs/enums/SimpleEncodingLiveJobOutputType.html @@ -1,4 +1,4 @@ SimpleEncodingLiveJobOutputType | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveJobOutputType

Output type

-

Export

Enumeration Members

CDN +

Export

Enumeration Members

CDN URL -

Enumeration Members

CDN

CDN: "CDN"

URL

URL: "URL"

Settings

Member Visibility

Theme

On This Page

CDNURL
\ No newline at end of file +

Enumeration Members

CDN

CDN: "CDN"

URL

URL: "URL"

Settings

Member Visibility

Theme

On This Page

CDNURL
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingLiveJobStatus.html b/docs/enums/SimpleEncodingLiveJobStatus.html index 39102bb5f..63348480a 100644 --- a/docs/enums/SimpleEncodingLiveJobStatus.html +++ b/docs/enums/SimpleEncodingLiveJobStatus.html @@ -1,4 +1,4 @@ -SimpleEncodingLiveJobStatus | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveJobStatus

Export

Enumeration Members

CANCELED +SimpleEncodingLiveJobStatus | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveJobStatus

Export

Enumeration Members

CANCELED CREATED ERROR EXECUTING @@ -6,4 +6,4 @@ RUNNING STARTING STOPPED -

Enumeration Members

CANCELED

CANCELED: "CANCELED"

CREATED

CREATED: "CREATED"

ERROR

ERROR: "ERROR"

EXECUTING

EXECUTING: "EXECUTING"

FAILURE

FAILURE: "FAILURE"

RUNNING

RUNNING: "RUNNING"

STARTING

STARTING: "STARTING"

STOPPED

STOPPED: "STOPPED"

Settings

Member Visibility

Theme

On This Page

CANCELEDCREATEDERROREXECUTINGFAILURERUNNINGSTARTINGSTOPPED
\ No newline at end of file +

Enumeration Members

CANCELED

CANCELED: "CANCELED"

CREATED

CREATED: "CREATED"

ERROR

ERROR: "ERROR"

EXECUTING

EXECUTING: "EXECUTING"

FAILURE

FAILURE: "FAILURE"

RUNNING

RUNNING: "RUNNING"

STARTING

STARTING: "STARTING"

STOPPED

STOPPED: "STOPPED"

Settings

Member Visibility

Theme

On This Page

CANCELEDCREATEDERROREXECUTINGFAILURERUNNINGSTARTINGSTOPPED
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingLiveMaxResolution.html b/docs/enums/SimpleEncodingLiveMaxResolution.html index a69ef1dd8..ac0f30f05 100644 --- a/docs/enums/SimpleEncodingLiveMaxResolution.html +++ b/docs/enums/SimpleEncodingLiveMaxResolution.html @@ -1,4 +1,4 @@ -SimpleEncodingLiveMaxResolution | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveMaxResolution

Export

Enumeration Members

FULL_HD +SimpleEncodingLiveMaxResolution | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveMaxResolution

Export

Enumeration Members

FULL_HD HD SD -

Enumeration Members

FULL_HD

FULL_HD: "FULL_HD"

HD

HD: "HD"

SD

SD: "SD"

Settings

Member Visibility

Theme

On This Page

FULL_HDHDSD
\ No newline at end of file +

Enumeration Members

FULL_HD

FULL_HD: "FULL_HD"

HD

HD: "HD"

SD

SD: "SD"

Settings

Member Visibility

Theme

On This Page

FULL_HDHDSD
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingLiveProfile.html b/docs/enums/SimpleEncodingLiveProfile.html index 2d5754b51..ecb5e90b9 100644 --- a/docs/enums/SimpleEncodingLiveProfile.html +++ b/docs/enums/SimpleEncodingLiveProfile.html @@ -1,3 +1,3 @@ -SimpleEncodingLiveProfile | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveProfile

Export

Enumeration Members

INCREASED_QUALITY +SimpleEncodingLiveProfile | @bitmovin/api-sdk

Enumeration SimpleEncodingLiveProfile

Export

Enumeration Members

INCREASED_QUALITY LOWER_LATENCY -

Enumeration Members

INCREASED_QUALITY

INCREASED_QUALITY: "INCREASED_QUALITY"

LOWER_LATENCY

LOWER_LATENCY: "LOWER_LATENCY"

Settings

Member Visibility

Theme

On This Page

INCREASED_QUALITYLOWER_LATENCY
\ No newline at end of file +

Enumeration Members

INCREASED_QUALITY

INCREASED_QUALITY: "INCREASED_QUALITY"

LOWER_LATENCY

LOWER_LATENCY: "LOWER_LATENCY"

Settings

Member Visibility

Theme

On This Page

INCREASED_QUALITYLOWER_LATENCY
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingVodJobInputSourceType.html b/docs/enums/SimpleEncodingVodJobInputSourceType.html index d7f80c329..96ee4bdb9 100644 --- a/docs/enums/SimpleEncodingVodJobInputSourceType.html +++ b/docs/enums/SimpleEncodingVodJobInputSourceType.html @@ -1,4 +1,4 @@ SimpleEncodingVodJobInputSourceType | @bitmovin/api-sdk

Enumeration SimpleEncodingVodJobInputSourceType

Input source type

-

Export

Enumeration Members

DIRECT_FILE_UPLOAD +

Export

Enumeration Members

DIRECT_FILE_UPLOAD URL -

Enumeration Members

DIRECT_FILE_UPLOAD

DIRECT_FILE_UPLOAD: "DIRECT_FILE_UPLOAD"

URL

URL: "URL"

Settings

Member Visibility

Theme

On This Page

DIRECT_FILE_UPLOADURL
\ No newline at end of file +

Enumeration Members

DIRECT_FILE_UPLOAD

DIRECT_FILE_UPLOAD: "DIRECT_FILE_UPLOAD"

URL

URL: "URL"

Settings

Member Visibility

Theme

On This Page

DIRECT_FILE_UPLOADURL
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingVodJobInputType.html b/docs/enums/SimpleEncodingVodJobInputType.html index 677d3ade6..7fdc15a4b 100644 --- a/docs/enums/SimpleEncodingVodJobInputType.html +++ b/docs/enums/SimpleEncodingVodJobInputType.html @@ -1,5 +1,5 @@ -SimpleEncodingVodJobInputType | @bitmovin/api-sdk

Enumeration SimpleEncodingVodJobInputType

Export

Enumeration Members

AUDIO +SimpleEncodingVodJobInputType | @bitmovin/api-sdk

Enumeration SimpleEncodingVodJobInputType

Export

Enumeration Members

AUDIO CLOSED_CAPTIONS SUBTITLES VIDEO -

Enumeration Members

AUDIO

AUDIO: "AUDIO"

CLOSED_CAPTIONS

CLOSED_CAPTIONS: "CLOSED_CAPTIONS"

SUBTITLES

SUBTITLES: "SUBTITLES"

VIDEO

VIDEO: "VIDEO"

Settings

Member Visibility

Theme

On This Page

AUDIOCLOSED_CAPTIONSSUBTITLESVIDEO
\ No newline at end of file +

Enumeration Members

AUDIO

AUDIO: "AUDIO"

CLOSED_CAPTIONS

CLOSED_CAPTIONS: "CLOSED_CAPTIONS"

SUBTITLES

SUBTITLES: "SUBTITLES"

VIDEO

VIDEO: "VIDEO"

Settings

Member Visibility

Theme

On This Page

AUDIOCLOSED_CAPTIONSSUBTITLESVIDEO
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingVodJobOutputType.html b/docs/enums/SimpleEncodingVodJobOutputType.html index 29c3f3bec..5a7b2ff1f 100644 --- a/docs/enums/SimpleEncodingVodJobOutputType.html +++ b/docs/enums/SimpleEncodingVodJobOutputType.html @@ -1,4 +1,4 @@ SimpleEncodingVodJobOutputType | @bitmovin/api-sdk

Enumeration SimpleEncodingVodJobOutputType

Output type

-

Export

Enumeration Members

CDN +

Export

Enumeration Members

CDN URL -

Enumeration Members

CDN

CDN: "CDN"

URL

URL: "URL"

Settings

Member Visibility

Theme

On This Page

CDNURL
\ No newline at end of file +

Enumeration Members

CDN

CDN: "CDN"

URL

URL: "URL"

Settings

Member Visibility

Theme

On This Page

CDNURL
\ No newline at end of file diff --git a/docs/enums/SimpleEncodingVodJobStatus.html b/docs/enums/SimpleEncodingVodJobStatus.html index 3c11820f1..2982e5135 100644 --- a/docs/enums/SimpleEncodingVodJobStatus.html +++ b/docs/enums/SimpleEncodingVodJobStatus.html @@ -1,8 +1,8 @@ -SimpleEncodingVodJobStatus | @bitmovin/api-sdk

Enumeration SimpleEncodingVodJobStatus

Export

Enumeration Members

CANCELED +SimpleEncodingVodJobStatus | @bitmovin/api-sdk

Enumeration SimpleEncodingVodJobStatus

Export

Enumeration Members

CANCELED CREATED ERROR EXECUTING FAILURE FINISHED RUNNING -

Enumeration Members

CANCELED

CANCELED: "CANCELED"

CREATED

CREATED: "CREATED"

ERROR

ERROR: "ERROR"

EXECUTING

EXECUTING: "EXECUTING"

FAILURE

FAILURE: "FAILURE"

FINISHED

FINISHED: "FINISHED"

RUNNING

RUNNING: "RUNNING"

Settings

Member Visibility

Theme

On This Page

CANCELEDCREATEDERROREXECUTINGFAILUREFINISHEDRUNNING
\ No newline at end of file +

Enumeration Members

CANCELED

CANCELED: "CANCELED"

CREATED

CREATED: "CREATED"

ERROR

ERROR: "ERROR"

EXECUTING

EXECUTING: "EXECUTING"

FAILURE

FAILURE: "FAILURE"

FINISHED

FINISHED: "FINISHED"

RUNNING

RUNNING: "RUNNING"

Settings

Member Visibility

Theme

On This Page

CANCELEDCREATEDERROREXECUTINGFAILUREFINISHEDRUNNING
\ No newline at end of file diff --git a/docs/enums/SmoothManifestDefaultVersion.html b/docs/enums/SmoothManifestDefaultVersion.html index 321aab40f..17245fa11 100644 --- a/docs/enums/SmoothManifestDefaultVersion.html +++ b/docs/enums/SmoothManifestDefaultVersion.html @@ -1,2 +1,2 @@ -SmoothManifestDefaultVersion | @bitmovin/api-sdk

Enumeration SmoothManifestDefaultVersion

Export

Enumeration Members

V1 -

Enumeration Members

V1

V1: "V1"

Settings

Member Visibility

Theme

On This Page

V1
\ No newline at end of file +SmoothManifestDefaultVersion | @bitmovin/api-sdk

Enumeration SmoothManifestDefaultVersion

Export

Enumeration Members

V1 +

Enumeration Members

V1

V1: "V1"

Settings

Member Visibility

Theme

On This Page

V1
\ No newline at end of file diff --git a/docs/enums/SmpteTimecodeFlavor.html b/docs/enums/SmpteTimecodeFlavor.html index 0de8e8375..b494e974c 100644 --- a/docs/enums/SmpteTimecodeFlavor.html +++ b/docs/enums/SmpteTimecodeFlavor.html @@ -1,4 +1,4 @@ -SmpteTimecodeFlavor | @bitmovin/api-sdk

Enumeration SmpteTimecodeFlavor

Export

Enumeration Members

AUTO +SmpteTimecodeFlavor | @bitmovin/api-sdk

Enumeration SmpteTimecodeFlavor

Export

Enumeration Members

AUTO DROP_FRAME NON_DROP_FRAME -

Enumeration Members

AUTO

AUTO: "AUTO"

DROP_FRAME

DROP_FRAME: "DROP_FRAME"

NON_DROP_FRAME

NON_DROP_FRAME: "NON_DROP_FRAME"

Settings

Member Visibility

Theme

On This Page

AUTODROP_FRAMENON_DROP_FRAME
\ No newline at end of file +

Enumeration Members

AUTO

AUTO: "AUTO"

DROP_FRAME

DROP_FRAME: "DROP_FRAME"

NON_DROP_FRAME

NON_DROP_FRAME: "NON_DROP_FRAME"

Settings

Member Visibility

Theme

On This Page

AUTODROP_FRAMENON_DROP_FRAME
\ No newline at end of file diff --git a/docs/enums/SourceChannelType.html b/docs/enums/SourceChannelType.html index 3f55ee56e..bee27ec09 100644 --- a/docs/enums/SourceChannelType.html +++ b/docs/enums/SourceChannelType.html @@ -1,5 +1,5 @@ SourceChannelType | @bitmovin/api-sdk

Enumeration SourceChannelType

Type of this source channel

-

Export

Enumeration Members

BACK_LEFT +

Export

Enumeration Members

BACK_LEFT BACK_RIGHT CENTER CHANNEL_NUMBER @@ -8,4 +8,4 @@ LOW_FREQUENCY SURROUND_LEFT SURROUND_RIGHT -

Enumeration Members

BACK_LEFT

BACK_LEFT: "BACK_LEFT"

BACK_RIGHT

BACK_RIGHT: "BACK_RIGHT"

CENTER

CENTER: "CENTER"

CHANNEL_NUMBER

CHANNEL_NUMBER: "CHANNEL_NUMBER"

FRONT_LEFT

FRONT_LEFT: "FRONT_LEFT"

FRONT_RIGHT

FRONT_RIGHT: "FRONT_RIGHT"

LOW_FREQUENCY

LOW_FREQUENCY: "LOW_FREQUENCY"

SURROUND_LEFT

SURROUND_LEFT: "SURROUND_LEFT"

SURROUND_RIGHT

SURROUND_RIGHT: "SURROUND_RIGHT"

Settings

Member Visibility

Theme

On This Page

BACK_LEFTBACK_RIGHTCENTERCHANNEL_NUMBERFRONT_LEFTFRONT_RIGHTLOW_FREQUENCYSURROUND_LEFTSURROUND_RIGHT
\ No newline at end of file +

Enumeration Members

BACK_LEFT

BACK_LEFT: "BACK_LEFT"

BACK_RIGHT

BACK_RIGHT: "BACK_RIGHT"

CENTER

CENTER: "CENTER"

CHANNEL_NUMBER

CHANNEL_NUMBER: "CHANNEL_NUMBER"

FRONT_LEFT

FRONT_LEFT: "FRONT_LEFT"

FRONT_RIGHT

FRONT_RIGHT: "FRONT_RIGHT"

LOW_FREQUENCY

LOW_FREQUENCY: "LOW_FREQUENCY"

SURROUND_LEFT

SURROUND_LEFT: "SURROUND_LEFT"

SURROUND_RIGHT

SURROUND_RIGHT: "SURROUND_RIGHT"

Settings

Member Visibility

Theme

On This Page

BACK_LEFTBACK_RIGHTCENTERCHANNEL_NUMBERFRONT_LEFTFRONT_RIGHTLOW_FREQUENCYSURROUND_LEFTSURROUND_RIGHT
\ No newline at end of file diff --git a/docs/enums/SpriteCreationMode.html b/docs/enums/SpriteCreationMode.html index 3a4ed8e69..1ccc11ae0 100644 --- a/docs/enums/SpriteCreationMode.html +++ b/docs/enums/SpriteCreationMode.html @@ -1,3 +1,3 @@ -SpriteCreationMode | @bitmovin/api-sdk

Enumeration SpriteCreationMode

Export

Enumeration Members

INTERVAL_END +SpriteCreationMode | @bitmovin/api-sdk

Enumeration SpriteCreationMode

Export

Enumeration Members

INTERVAL_END INTERVAL_START -

Enumeration Members

INTERVAL_END

INTERVAL_END: "INTERVAL_END"

INTERVAL_START

INTERVAL_START: "INTERVAL_START"

Settings

Member Visibility

Theme

On This Page

INTERVAL_ENDINTERVAL_START
\ No newline at end of file +

Enumeration Members

INTERVAL_END

INTERVAL_END: "INTERVAL_END"

INTERVAL_START

INTERVAL_START: "INTERVAL_START"

Settings

Member Visibility

Theme

On This Page

INTERVAL_ENDINTERVAL_START
\ No newline at end of file diff --git a/docs/enums/SpriteUnit.html b/docs/enums/SpriteUnit.html index ac1f62b50..5956a8bee 100644 --- a/docs/enums/SpriteUnit.html +++ b/docs/enums/SpriteUnit.html @@ -1,3 +1,3 @@ -SpriteUnit | @bitmovin/api-sdk

Enumeration SpriteUnit

Export

Enumeration Members

PERCENTS +SpriteUnit | @bitmovin/api-sdk

Enumeration SpriteUnit

Export

Enumeration Members

PERCENTS SECONDS -

Enumeration Members

PERCENTS

PERCENTS: "PERCENTS"

SECONDS

SECONDS: "SECONDS"

Settings

Member Visibility

Theme

On This Page

PERCENTSSECONDS
\ No newline at end of file +

Enumeration Members

PERCENTS

PERCENTS: "PERCENTS"

SECONDS

SECONDS: "SECONDS"

Settings

Member Visibility

Theme

On This Page

PERCENTSSECONDS
\ No newline at end of file diff --git a/docs/enums/SrtMode.html b/docs/enums/SrtMode.html index 86d602d2a..15528b41e 100644 --- a/docs/enums/SrtMode.html +++ b/docs/enums/SrtMode.html @@ -1,3 +1,3 @@ -SrtMode | @bitmovin/api-sdk

Enumeration SrtMode

Export

Enumeration Members

CALLER +SrtMode | @bitmovin/api-sdk

Enumeration SrtMode

Export

Enumeration Members

CALLER LISTENER -

Enumeration Members

CALLER

CALLER: "CALLER"

LISTENER

LISTENER: "LISTENER"

Settings

Member Visibility

Theme

On This Page

CALLERLISTENER
\ No newline at end of file +

Enumeration Members

CALLER

CALLER: "CALLER"

LISTENER

LISTENER: "LISTENER"

Settings

Member Visibility

Theme

On This Page

CALLERLISTENER
\ No newline at end of file diff --git a/docs/enums/StaticIpStatus.html b/docs/enums/StaticIpStatus.html index c3fbd41e6..546e353b2 100644 --- a/docs/enums/StaticIpStatus.html +++ b/docs/enums/StaticIpStatus.html @@ -1,5 +1,5 @@ -StaticIpStatus | @bitmovin/api-sdk

Enumeration StaticIpStatus

Export

Enumeration Members

CREATING +StaticIpStatus | @bitmovin/api-sdk

Enumeration StaticIpStatus

Export

Enumeration Members

CREATING ERROR UNUSED USED -

Enumeration Members

CREATING

CREATING: "CREATING"

ERROR

ERROR: "ERROR"

UNUSED

UNUSED: "UNUSED"

USED

USED: "USED"

Settings

Member Visibility

Theme

On This Page

CREATINGERRORUNUSEDUSED
\ No newline at end of file +

Enumeration Members

CREATING

CREATING: "CREATING"

ERROR

ERROR: "ERROR"

UNUSED

UNUSED: "UNUSED"

USED

USED: "USED"

Settings

Member Visibility

Theme

On This Page

CREATINGERRORUNUSEDUSED
\ No newline at end of file diff --git a/docs/enums/StatisticsPerTitleStream.html b/docs/enums/StatisticsPerTitleStream.html index 6240e8d0c..9076c8164 100644 --- a/docs/enums/StatisticsPerTitleStream.html +++ b/docs/enums/StatisticsPerTitleStream.html @@ -1,3 +1,3 @@ -StatisticsPerTitleStream | @bitmovin/api-sdk

Enumeration StatisticsPerTitleStream

Export

Enumeration Members

DISABLED +StatisticsPerTitleStream | @bitmovin/api-sdk

Enumeration StatisticsPerTitleStream

Export

Enumeration Members

DISABLED ENABLED -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

ENABLED

ENABLED: "ENABLED"

Settings

Member Visibility

Theme

On This Page

DISABLEDENABLED
\ No newline at end of file diff --git a/docs/enums/StatisticsResolution.html b/docs/enums/StatisticsResolution.html index c6fa1c49d..116bd2882 100644 --- a/docs/enums/StatisticsResolution.html +++ b/docs/enums/StatisticsResolution.html @@ -1,5 +1,5 @@ -StatisticsResolution | @bitmovin/api-sdk

Enumeration StatisticsResolution

Export

Enumeration Members

HD +StatisticsResolution | @bitmovin/api-sdk

Enumeration StatisticsResolution

Export

Enumeration Members

HD SD UHD UHD_8K -

Enumeration Members

HD

HD: "HD"

SD

SD: "SD"

UHD

UHD: "UHD"

UHD_8K

UHD_8K: "UHD_8K"

Settings

Member Visibility

Theme

On This Page

HDSDUHDUHD_8K
\ No newline at end of file +

Enumeration Members

HD

HD: "HD"

SD

SD: "SD"

UHD

UHD: "UHD"

UHD_8K

UHD_8K: "UHD_8K"

Settings

Member Visibility

Theme

On This Page

HDSDUHDUHD_8K
\ No newline at end of file diff --git a/docs/enums/Status.html b/docs/enums/Status.html index 41870d4ca..5fd2ee8e3 100644 --- a/docs/enums/Status.html +++ b/docs/enums/Status.html @@ -1,8 +1,8 @@ -Status | @bitmovin/api-sdk

Enumeration Status

Export

Enumeration Members

CANCELED +Status | @bitmovin/api-sdk

Enumeration Status

Export

Enumeration Members

CANCELED CREATED ERROR FINISHED QUEUED RUNNING TRANSFER_ERROR -

Enumeration Members

CANCELED

CANCELED: "CANCELED"

CREATED

CREATED: "CREATED"

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

QUEUED

QUEUED: "QUEUED"

RUNNING

RUNNING: "RUNNING"

TRANSFER_ERROR

TRANSFER_ERROR: "TRANSFER_ERROR"

Settings

Member Visibility

Theme

On This Page

CANCELEDCREATEDERRORFINISHEDQUEUEDRUNNINGTRANSFER_ERROR
\ No newline at end of file +

Enumeration Members

CANCELED

CANCELED: "CANCELED"

CREATED

CREATED: "CREATED"

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

QUEUED

QUEUED: "QUEUED"

RUNNING

RUNNING: "RUNNING"

TRANSFER_ERROR

TRANSFER_ERROR: "TRANSFER_ERROR"

Settings

Member Visibility

Theme

On This Page

CANCELEDCREATEDERRORFINISHEDQUEUEDRUNNINGTRANSFER_ERROR
\ No newline at end of file diff --git a/docs/enums/StreamCaptionOutputFormat.html b/docs/enums/StreamCaptionOutputFormat.html index e9e79892b..152056491 100644 --- a/docs/enums/StreamCaptionOutputFormat.html +++ b/docs/enums/StreamCaptionOutputFormat.html @@ -1,2 +1,2 @@ -StreamCaptionOutputFormat | @bitmovin/api-sdk

Enumeration StreamCaptionOutputFormat

Export

Enumeration Members

WEBVTT -

Enumeration Members

WEBVTT

WEBVTT: "WEBVTT"

Settings

Member Visibility

Theme

On This Page

WEBVTT
\ No newline at end of file +StreamCaptionOutputFormat | @bitmovin/api-sdk

Enumeration StreamCaptionOutputFormat

Export

Enumeration Members

WEBVTT +

Enumeration Members

WEBVTT

WEBVTT: "WEBVTT"

Settings

Member Visibility

Theme

On This Page

WEBVTT
\ No newline at end of file diff --git a/docs/enums/StreamConditionsMode.html b/docs/enums/StreamConditionsMode.html index 2801d274f..bb1f1ec31 100644 --- a/docs/enums/StreamConditionsMode.html +++ b/docs/enums/StreamConditionsMode.html @@ -1,3 +1,3 @@ -StreamConditionsMode | @bitmovin/api-sdk

Enumeration StreamConditionsMode

Export

Enumeration Members

DROP_MUXING +StreamConditionsMode | @bitmovin/api-sdk

Enumeration StreamConditionsMode

Export

Enumeration Members

DROP_MUXING DROP_STREAM -

Enumeration Members

DROP_MUXING

DROP_MUXING: "DROP_MUXING"

DROP_STREAM

DROP_STREAM: "DROP_STREAM"

Settings

Member Visibility

Theme

On This Page

DROP_MUXINGDROP_STREAM
\ No newline at end of file +

Enumeration Members

DROP_MUXING

DROP_MUXING: "DROP_MUXING"

DROP_STREAM

DROP_STREAM: "DROP_STREAM"

Settings

Member Visibility

Theme

On This Page

DROP_MUXINGDROP_STREAM
\ No newline at end of file diff --git a/docs/enums/StreamKeyConfigurationType.html b/docs/enums/StreamKeyConfigurationType.html index 09100572f..5b032c106 100644 --- a/docs/enums/StreamKeyConfigurationType.html +++ b/docs/enums/StreamKeyConfigurationType.html @@ -1,3 +1,3 @@ -StreamKeyConfigurationType | @bitmovin/api-sdk

Enumeration StreamKeyConfigurationType

Export

Enumeration Members

ASSIGN +StreamKeyConfigurationType | @bitmovin/api-sdk

Enumeration StreamKeyConfigurationType

Export

Enumeration Members

ASSIGN GENERATE -

Enumeration Members

ASSIGN

ASSIGN: "ASSIGN"

GENERATE

GENERATE: "GENERATE"

Settings

Member Visibility

Theme

On This Page

ASSIGNGENERATE
\ No newline at end of file +

Enumeration Members

ASSIGN

ASSIGN: "ASSIGN"

GENERATE

GENERATE: "GENERATE"

Settings

Member Visibility

Theme

On This Page

ASSIGNGENERATE
\ No newline at end of file diff --git a/docs/enums/StreamKeyStatus.html b/docs/enums/StreamKeyStatus.html index 8ef20d184..ec7b6ce82 100644 --- a/docs/enums/StreamKeyStatus.html +++ b/docs/enums/StreamKeyStatus.html @@ -1,4 +1,4 @@ StreamKeyStatus | @bitmovin/api-sdk

Enumeration StreamKeyStatus

Status of the stream key

-

Export

Enumeration Members

ASSIGNED +

Export

Enumeration Members

ASSIGNED UNASSIGNED -

Enumeration Members

ASSIGNED

ASSIGNED: "ASSIGNED"

UNASSIGNED

UNASSIGNED: "UNASSIGNED"

Settings

Member Visibility

Theme

On This Page

ASSIGNEDUNASSIGNED
\ No newline at end of file +

Enumeration Members

ASSIGNED

ASSIGNED: "ASSIGNED"

UNASSIGNED

UNASSIGNED: "UNASSIGNED"

Settings

Member Visibility

Theme

On This Page

ASSIGNEDUNASSIGNED
\ No newline at end of file diff --git a/docs/enums/StreamKeyType.html b/docs/enums/StreamKeyType.html index ce1d291ea..3c82884c4 100644 --- a/docs/enums/StreamKeyType.html +++ b/docs/enums/StreamKeyType.html @@ -1,4 +1,4 @@ StreamKeyType | @bitmovin/api-sdk

Enumeration StreamKeyType

Type of the stream key

-

Export

Enumeration Members

RESERVED +

Export

Enumeration Members

RESERVED TEMPORARY -

Enumeration Members

RESERVED

RESERVED: "RESERVED"

TEMPORARY

TEMPORARY: "TEMPORARY"

Settings

Member Visibility

Theme

On This Page

RESERVEDTEMPORARY
\ No newline at end of file +

Enumeration Members

RESERVED

RESERVED: "RESERVED"

TEMPORARY

TEMPORARY: "TEMPORARY"

Settings

Member Visibility

Theme

On This Page

RESERVEDTEMPORARY
\ No newline at end of file diff --git a/docs/enums/StreamMode.html b/docs/enums/StreamMode.html index 3a7d95708..b2f65eaf7 100644 --- a/docs/enums/StreamMode.html +++ b/docs/enums/StreamMode.html @@ -1,6 +1,6 @@ -StreamMode | @bitmovin/api-sdk

Enumeration StreamMode

Export

Enumeration Members

PER_TITLE_RESULT +StreamMode | @bitmovin/api-sdk

Enumeration StreamMode

Export

Enumeration Members

PER_TITLE_RESULT PER_TITLE_TEMPLATE PER_TITLE_TEMPLATE_FIXED_RESOLUTION PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE STANDARD -

Enumeration Members

PER_TITLE_RESULT

PER_TITLE_RESULT: "PER_TITLE_RESULT"

PER_TITLE_TEMPLATE

PER_TITLE_TEMPLATE: "PER_TITLE_TEMPLATE"

PER_TITLE_TEMPLATE_FIXED_RESOLUTION

PER_TITLE_TEMPLATE_FIXED_RESOLUTION: "PER_TITLE_TEMPLATE_FIXED_RESOLUTION"

PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE

PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE: "PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE"

STANDARD

STANDARD: "STANDARD"

Settings

Member Visibility

Theme

On This Page

PER_TITLE_RESULTPER_TITLE_TEMPLATEPER_TITLE_TEMPLATE_FIXED_RESOLUTIONPER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATESTANDARD
\ No newline at end of file +

Enumeration Members

PER_TITLE_RESULT

PER_TITLE_RESULT: "PER_TITLE_RESULT"

PER_TITLE_TEMPLATE

PER_TITLE_TEMPLATE: "PER_TITLE_TEMPLATE"

PER_TITLE_TEMPLATE_FIXED_RESOLUTION

PER_TITLE_TEMPLATE_FIXED_RESOLUTION: "PER_TITLE_TEMPLATE_FIXED_RESOLUTION"

PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE

PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE: "PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE"

STANDARD

STANDARD: "STANDARD"

Settings

Member Visibility

Theme

On This Page

PER_TITLE_RESULTPER_TITLE_TEMPLATEPER_TITLE_TEMPLATE_FIXED_RESOLUTIONPER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATESTANDARD
\ No newline at end of file diff --git a/docs/enums/StreamSelectionMode.html b/docs/enums/StreamSelectionMode.html index aa9a36c9c..9994d6c96 100644 --- a/docs/enums/StreamSelectionMode.html +++ b/docs/enums/StreamSelectionMode.html @@ -1,6 +1,6 @@ -StreamSelectionMode | @bitmovin/api-sdk

Enumeration StreamSelectionMode

Export

Enumeration Members

AUDIO_RELATIVE +StreamSelectionMode | @bitmovin/api-sdk

Enumeration StreamSelectionMode

Export

Enumeration Members

AUDIO_RELATIVE AUTO POSITION_ABSOLUTE SUBTITLE_RELATIVE VIDEO_RELATIVE -

Enumeration Members

AUDIO_RELATIVE

AUDIO_RELATIVE: "AUDIO_RELATIVE"

AUTO

AUTO: "AUTO"

POSITION_ABSOLUTE

POSITION_ABSOLUTE: "POSITION_ABSOLUTE"

SUBTITLE_RELATIVE

SUBTITLE_RELATIVE: "SUBTITLE_RELATIVE"

VIDEO_RELATIVE

VIDEO_RELATIVE: "VIDEO_RELATIVE"

Settings

Member Visibility

Theme

On This Page

AUDIO_RELATIVEAUTOPOSITION_ABSOLUTESUBTITLE_RELATIVEVIDEO_RELATIVE
\ No newline at end of file +

Enumeration Members

AUDIO_RELATIVE

AUDIO_RELATIVE: "AUDIO_RELATIVE"

AUTO

AUTO: "AUTO"

POSITION_ABSOLUTE

POSITION_ABSOLUTE: "POSITION_ABSOLUTE"

SUBTITLE_RELATIVE

SUBTITLE_RELATIVE: "SUBTITLE_RELATIVE"

VIDEO_RELATIVE

VIDEO_RELATIVE: "VIDEO_RELATIVE"

Settings

Member Visibility

Theme

On This Page

AUDIO_RELATIVEAUTOPOSITION_ABSOLUTESUBTITLE_RELATIVEVIDEO_RELATIVE
\ No newline at end of file diff --git a/docs/enums/StreamsEncodingProfile.html b/docs/enums/StreamsEncodingProfile.html index 71f20321b..ce401d6aa 100644 --- a/docs/enums/StreamsEncodingProfile.html +++ b/docs/enums/StreamsEncodingProfile.html @@ -1,3 +1,3 @@ -StreamsEncodingProfile | @bitmovin/api-sdk

Enumeration StreamsEncodingProfile

Export

Enumeration Members

FIXED_RESOLUTIONS +StreamsEncodingProfile | @bitmovin/api-sdk

Enumeration StreamsEncodingProfile

Export

Enumeration Members

FIXED_RESOLUTIONS PER_TITLE -

Enumeration Members

FIXED_RESOLUTIONS

FIXED_RESOLUTIONS: "FIXED_RESOLUTIONS"

PER_TITLE

PER_TITLE: "PER_TITLE"

Settings

Member Visibility

Theme

On This Page

FIXED_RESOLUTIONSPER_TITLE
\ No newline at end of file +

Enumeration Members

FIXED_RESOLUTIONS

FIXED_RESOLUTIONS: "FIXED_RESOLUTIONS"

PER_TITLE

PER_TITLE: "PER_TITLE"

Settings

Member Visibility

Theme

On This Page

FIXED_RESOLUTIONSPER_TITLE
\ No newline at end of file diff --git a/docs/enums/StreamsLiveLifeCycle.html b/docs/enums/StreamsLiveLifeCycle.html index 44d461efd..72a7e2405 100644 --- a/docs/enums/StreamsLiveLifeCycle.html +++ b/docs/enums/StreamsLiveLifeCycle.html @@ -1,5 +1,5 @@ -StreamsLiveLifeCycle | @bitmovin/api-sdk

Enumeration StreamsLiveLifeCycle

Export

Enumeration Members

ERROR +StreamsLiveLifeCycle | @bitmovin/api-sdk

Enumeration StreamsLiveLifeCycle

Export

Enumeration Members

ERROR PROVISIONING RUNNING STOPPED -

Enumeration Members

ERROR

ERROR: "ERROR"

PROVISIONING

PROVISIONING: "PROVISIONING"

RUNNING

RUNNING: "RUNNING"

STOPPED

STOPPED: "STOPPED"

Settings

Member Visibility

Theme

On This Page

ERRORPROVISIONINGRUNNINGSTOPPED
\ No newline at end of file +

Enumeration Members

ERROR

ERROR: "ERROR"

PROVISIONING

PROVISIONING: "PROVISIONING"

RUNNING

RUNNING: "RUNNING"

STOPPED

STOPPED: "STOPPED"

Settings

Member Visibility

Theme

On This Page

ERRORPROVISIONINGRUNNINGSTOPPED
\ No newline at end of file diff --git a/docs/enums/StreamsTrimmingStatus.html b/docs/enums/StreamsTrimmingStatus.html index 435435f28..8dca80b64 100644 --- a/docs/enums/StreamsTrimmingStatus.html +++ b/docs/enums/StreamsTrimmingStatus.html @@ -1,6 +1,6 @@ -StreamsTrimmingStatus | @bitmovin/api-sdk

Enumeration StreamsTrimmingStatus

Export

Enumeration Members

AVAILABLE +StreamsTrimmingStatus | @bitmovin/api-sdk

Enumeration StreamsTrimmingStatus

Export

Enumeration Members

AVAILABLE ERROR FINISHED STARTED UNAVAILABLE -

Enumeration Members

AVAILABLE

AVAILABLE: "AVAILABLE"

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

STARTED

STARTED: "STARTED"

UNAVAILABLE

UNAVAILABLE: "UNAVAILABLE"

Settings

Member Visibility

Theme

On This Page

AVAILABLEERRORFINISHEDSTARTEDUNAVAILABLE
\ No newline at end of file +

Enumeration Members

AVAILABLE

AVAILABLE: "AVAILABLE"

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

STARTED

STARTED: "STARTED"

UNAVAILABLE

UNAVAILABLE: "UNAVAILABLE"

Settings

Member Visibility

Theme

On This Page

AVAILABLEERRORFINISHEDSTARTEDUNAVAILABLE
\ No newline at end of file diff --git a/docs/enums/StreamsType.html b/docs/enums/StreamsType.html index 615a22a64..313ed881b 100644 --- a/docs/enums/StreamsType.html +++ b/docs/enums/StreamsType.html @@ -1,3 +1,3 @@ -StreamsType | @bitmovin/api-sdk

Enumeration StreamsType

Export

Enumeration Members

LIVE +StreamsType | @bitmovin/api-sdk

Enumeration StreamsType

Export

Enumeration Members

LIVE VIDEO -

Enumeration Members

LIVE

LIVE: "LIVE"

VIDEO

VIDEO: "VIDEO"

Settings

Member Visibility

Theme

On This Page

LIVEVIDEO
\ No newline at end of file +

Enumeration Members

LIVE

LIVE: "LIVE"

VIDEO

VIDEO: "VIDEO"

Settings

Member Visibility

Theme

On This Page

LIVEVIDEO
\ No newline at end of file diff --git a/docs/enums/StreamsVideoEncodingStatus.html b/docs/enums/StreamsVideoEncodingStatus.html index d463f28ff..da84b00ad 100644 --- a/docs/enums/StreamsVideoEncodingStatus.html +++ b/docs/enums/StreamsVideoEncodingStatus.html @@ -1,4 +1,4 @@ -StreamsVideoEncodingStatus | @bitmovin/api-sdk

Enumeration StreamsVideoEncodingStatus

Export

Enumeration Members

ERROR +StreamsVideoEncodingStatus | @bitmovin/api-sdk

Enumeration StreamsVideoEncodingStatus

Export

Enumeration Members

ERROR FINISHED STARTED -

Enumeration Members

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

STARTED

STARTED: "STARTED"

Settings

Member Visibility

Theme

On This Page

ERRORFINISHEDSTARTED
\ No newline at end of file +

Enumeration Members

ERROR

ERROR: "ERROR"

FINISHED

FINISHED: "FINISHED"

STARTED

STARTED: "STARTED"

Settings

Member Visibility

Theme

On This Page

ERRORFINISHEDSTARTED
\ No newline at end of file diff --git a/docs/enums/StreamsVideoQuality.html b/docs/enums/StreamsVideoQuality.html index f7af0d3fe..f9e1fd7dd 100644 --- a/docs/enums/StreamsVideoQuality.html +++ b/docs/enums/StreamsVideoQuality.html @@ -1,4 +1,4 @@ -StreamsVideoQuality | @bitmovin/api-sdk

Enumeration StreamsVideoQuality

Export

Enumeration Members

DEFAULT +StreamsVideoQuality | @bitmovin/api-sdk

Enumeration StreamsVideoQuality

Export

Enumeration Members

DEFAULT NONE PREVIEW -

Enumeration Members

DEFAULT

DEFAULT: "DEFAULT"

NONE

NONE: "NONE"

PREVIEW

PREVIEW: "PREVIEW"

Settings

Member Visibility

Theme

On This Page

DEFAULTNONEPREVIEW
\ No newline at end of file +

Enumeration Members

DEFAULT

DEFAULT: "DEFAULT"

NONE

NONE: "NONE"

PREVIEW

PREVIEW: "PREVIEW"

Settings

Member Visibility

Theme

On This Page

DEFAULTNONEPREVIEW
\ No newline at end of file diff --git a/docs/enums/StreamsVideoStatus.html b/docs/enums/StreamsVideoStatus.html index 41500983c..58b3648e0 100644 --- a/docs/enums/StreamsVideoStatus.html +++ b/docs/enums/StreamsVideoStatus.html @@ -1,3 +1,3 @@ -StreamsVideoStatus | @bitmovin/api-sdk

Enumeration StreamsVideoStatus

Export

Enumeration Members

PUBLISHED +StreamsVideoStatus | @bitmovin/api-sdk

Enumeration StreamsVideoStatus

Export

Enumeration Members

PUBLISHED UNPUBLISHED -

Enumeration Members

PUBLISHED

PUBLISHED: "PUBLISHED"

UNPUBLISHED

UNPUBLISHED: "UNPUBLISHED"

Settings

Member Visibility

Theme

On This Page

PUBLISHEDUNPUBLISHED
\ No newline at end of file +

Enumeration Members

PUBLISHED

PUBLISHED: "PUBLISHED"

UNPUBLISHED

UNPUBLISHED: "UNPUBLISHED"

Settings

Member Visibility

Theme

On This Page

PUBLISHEDUNPUBLISHED
\ No newline at end of file diff --git a/docs/enums/TextFilterFont.html b/docs/enums/TextFilterFont.html index 1be47e196..93c50b676 100644 --- a/docs/enums/TextFilterFont.html +++ b/docs/enums/TextFilterFont.html @@ -1,8 +1,8 @@ -TextFilterFont | @bitmovin/api-sdk

Enumeration TextFilterFont

Export

Enumeration Members

DEJAVUSANS +TextFilterFont | @bitmovin/api-sdk

Enumeration TextFilterFont

Export

Enumeration Members

DEJAVUSANS DEJAVUSANSMONO DEJAVUSERIF ROBOTO ROBOTOBLACK ROBOTOCONDENSED ROBOTOMONO -

Enumeration Members

DEJAVUSANS

DEJAVUSANS: "DEJAVUSANS"

DEJAVUSANSMONO

DEJAVUSANSMONO: "DEJAVUSANSMONO"

DEJAVUSERIF

DEJAVUSERIF: "DEJAVUSERIF"

ROBOTO

ROBOTO: "ROBOTO"

ROBOTOBLACK

ROBOTOBLACK: "ROBOTOBLACK"

ROBOTOCONDENSED

ROBOTOCONDENSED: "ROBOTOCONDENSED"

ROBOTOMONO

ROBOTOMONO: "ROBOTOMONO"

Settings

Member Visibility

Theme

On This Page

DEJAVUSANSDEJAVUSANSMONODEJAVUSERIFROBOTOROBOTOBLACKROBOTOCONDENSEDROBOTOMONO
\ No newline at end of file +

Enumeration Members

DEJAVUSANS

DEJAVUSANS: "DEJAVUSANS"

DEJAVUSANSMONO

DEJAVUSANSMONO: "DEJAVUSANSMONO"

DEJAVUSERIF

DEJAVUSERIF: "DEJAVUSERIF"

ROBOTO

ROBOTO: "ROBOTO"

ROBOTOBLACK

ROBOTOBLACK: "ROBOTOBLACK"

ROBOTOCONDENSED

ROBOTOCONDENSED: "ROBOTOCONDENSED"

ROBOTOMONO

ROBOTOMONO: "ROBOTOMONO"

Settings

Member Visibility

Theme

On This Page

DEJAVUSANSDEJAVUSANSMONODEJAVUSERIFROBOTOROBOTOBLACKROBOTOCONDENSEDROBOTOMONO
\ No newline at end of file diff --git a/docs/enums/ThumbnailAspectMode.html b/docs/enums/ThumbnailAspectMode.html index 378b6b03f..fd443cfd3 100644 --- a/docs/enums/ThumbnailAspectMode.html +++ b/docs/enums/ThumbnailAspectMode.html @@ -1,4 +1,4 @@ -ThumbnailAspectMode | @bitmovin/api-sdk

Enumeration ThumbnailAspectMode

Export

Enumeration Members

CROP +ThumbnailAspectMode | @bitmovin/api-sdk

Enumeration ThumbnailAspectMode

Export

Enumeration Members

CROP PAD STRETCH -

Enumeration Members

CROP

CROP: "CROP"

PAD

PAD: "PAD"

STRETCH

STRETCH: "STRETCH"

Settings

Member Visibility

Theme

On This Page

CROPPADSTRETCH
\ No newline at end of file +

Enumeration Members

CROP

CROP: "CROP"

PAD

PAD: "PAD"

STRETCH

STRETCH: "STRETCH"

Settings

Member Visibility

Theme

On This Page

CROPPADSTRETCH
\ No newline at end of file diff --git a/docs/enums/ThumbnailUnit.html b/docs/enums/ThumbnailUnit.html index 82d0c4d95..53dc6264b 100644 --- a/docs/enums/ThumbnailUnit.html +++ b/docs/enums/ThumbnailUnit.html @@ -1,3 +1,3 @@ -ThumbnailUnit | @bitmovin/api-sdk

Enumeration ThumbnailUnit

Export

Enumeration Members

PERCENTS +ThumbnailUnit | @bitmovin/api-sdk

Enumeration ThumbnailUnit

Export

Enumeration Members

PERCENTS SECONDS -

Enumeration Members

PERCENTS

PERCENTS: "PERCENTS"

SECONDS

SECONDS: "SECONDS"

Settings

Member Visibility

Theme

On This Page

PERCENTSSECONDS
\ No newline at end of file +

Enumeration Members

PERCENTS

PERCENTS: "PERCENTS"

SECONDS

SECONDS: "SECONDS"

Settings

Member Visibility

Theme

On This Page

PERCENTSSECONDS
\ No newline at end of file diff --git a/docs/enums/TransferVersion.html b/docs/enums/TransferVersion.html index 4a8db5853..58c3f31d8 100644 --- a/docs/enums/TransferVersion.html +++ b/docs/enums/TransferVersion.html @@ -1,3 +1,3 @@ -TransferVersion | @bitmovin/api-sdk

Enumeration TransferVersion

Export

Enumeration Members

DEFAULT +TransferVersion | @bitmovin/api-sdk

Enumeration TransferVersion

Export

Enumeration Members

DEFAULT POOL -

Enumeration Members

DEFAULT

DEFAULT: "DEFAULT"

POOL

POOL: "POOL"

Settings

Member Visibility

Theme

On This Page

DEFAULTPOOL
\ No newline at end of file +

Enumeration Members

DEFAULT

DEFAULT: "DEFAULT"

POOL

POOL: "POOL"

Settings

Member Visibility

Theme

On This Page

DEFAULTPOOL
\ No newline at end of file diff --git a/docs/enums/TransformSkipMode.html b/docs/enums/TransformSkipMode.html index c3918ffdb..a67292143 100644 --- a/docs/enums/TransformSkipMode.html +++ b/docs/enums/TransformSkipMode.html @@ -1,5 +1,5 @@ TransformSkipMode | @bitmovin/api-sdk

Enumeration TransformSkipMode

Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks.

-

Export

Enumeration Members

FAST +

Export

Enumeration Members

FAST NONE NORMAL -

Enumeration Members

FAST

FAST: "FAST"

NONE

NONE: "NONE"

NORMAL

NORMAL: "NORMAL"

Settings

Member Visibility

Theme

On This Page

FASTNONENORMAL
\ No newline at end of file +

Enumeration Members

FAST

FAST: "FAST"

NONE

NONE: "NONE"

NORMAL

NORMAL: "NORMAL"

Settings

Member Visibility

Theme

On This Page

FASTNONENORMAL
\ No newline at end of file diff --git a/docs/enums/TuInterDepth.html b/docs/enums/TuInterDepth.html index 8ef34d5bb..44646a815 100644 --- a/docs/enums/TuInterDepth.html +++ b/docs/enums/TuInterDepth.html @@ -1,6 +1,6 @@ TuInterDepth | @bitmovin/api-sdk

Enumeration TuInterDepth

Extra recursion depth for intra coded units

-

Export

Enumeration Members

D1 +

Export

Enumeration Members

D1 D2 D3 D4 -

Enumeration Members

D1

D1: "1"

D2

D2: "2"

D3

D3: "3"

D4

D4: "4"

Settings

Member Visibility

Theme

On This Page

D1D2D3D4
\ No newline at end of file +

Enumeration Members

D1

D1: "1"

D2

D2: "2"

D3

D3: "3"

D4

D4: "4"

Settings

Member Visibility

Theme

On This Page

D1D2D3D4
\ No newline at end of file diff --git a/docs/enums/TuIntraDepth.html b/docs/enums/TuIntraDepth.html index fb6351a44..1b34c9d13 100644 --- a/docs/enums/TuIntraDepth.html +++ b/docs/enums/TuIntraDepth.html @@ -1,6 +1,6 @@ TuIntraDepth | @bitmovin/api-sdk

Enumeration TuIntraDepth

Extra recursion depth for inter coded units

-

Export

Enumeration Members

D1 +

Export

Enumeration Members

D1 D2 D3 D4 -

Enumeration Members

D1

D1: "1"

D2

D2: "2"

D3

D3: "3"

D4

D4: "4"

Settings

Member Visibility

Theme

On This Page

D1D2D3D4
\ No newline at end of file +

Enumeration Members

D1

D1: "1"

D2

D2: "2"

D3

D3: "3"

D4

D4: "4"

Settings

Member Visibility

Theme

On This Page

D1D2D3D4
\ No newline at end of file diff --git a/docs/enums/VariantStreamDroppingMode.html b/docs/enums/VariantStreamDroppingMode.html index e1bf932f7..79e12791d 100644 --- a/docs/enums/VariantStreamDroppingMode.html +++ b/docs/enums/VariantStreamDroppingMode.html @@ -1,4 +1,4 @@ VariantStreamDroppingMode | @bitmovin/api-sdk

Enumeration VariantStreamDroppingMode

Variant stream dropping mode.

-

Export

Enumeration Members

AUDIO +

Export

Enumeration Members

AUDIO STREAM -

Enumeration Members

AUDIO

AUDIO: "AUDIO"

STREAM

STREAM: "STREAM"

Settings

Member Visibility

Theme

On This Page

AUDIOSTREAM
\ No newline at end of file +

Enumeration Members

AUDIO

AUDIO: "AUDIO"

STREAM

STREAM: "STREAM"

Settings

Member Visibility

Theme

On This Page

AUDIOSTREAM
\ No newline at end of file diff --git a/docs/enums/VerticalLowPassFilteringMode.html b/docs/enums/VerticalLowPassFilteringMode.html index 6e91e894d..afff22bff 100644 --- a/docs/enums/VerticalLowPassFilteringMode.html +++ b/docs/enums/VerticalLowPassFilteringMode.html @@ -1,5 +1,5 @@ VerticalLowPassFilteringMode | @bitmovin/api-sdk

Enumeration VerticalLowPassFilteringMode

Mode for vertical low pass filtering

-

Export

Enumeration Members

COMPLEX +

Export

Enumeration Members

COMPLEX DISABLED LOW_PASS -

Enumeration Members

COMPLEX

COMPLEX: "COMPLEX"

DISABLED

DISABLED: "DISABLED"

LOW_PASS

LOW_PASS: "LOW_PASS"

Settings

Member Visibility

Theme

On This Page

COMPLEXDISABLEDLOW_PASS
\ No newline at end of file +

Enumeration Members

COMPLEX

COMPLEX: "COMPLEX"

DISABLED

DISABLED: "DISABLED"

LOW_PASS

LOW_PASS: "LOW_PASS"

Settings

Member Visibility

Theme

On This Page

COMPLEXDISABLEDLOW_PASS
\ No newline at end of file diff --git a/docs/enums/VideoFormat.html b/docs/enums/VideoFormat.html index 2d354f7cc..2f4193437 100644 --- a/docs/enums/VideoFormat.html +++ b/docs/enums/VideoFormat.html @@ -1,7 +1,7 @@ -VideoFormat | @bitmovin/api-sdk

Enumeration VideoFormat

Export

Enumeration Members

COMPONENT +VideoFormat | @bitmovin/api-sdk

Enumeration VideoFormat

Export

Enumeration Members

COMPONENT MAC NTSC PAL SECAM UNDEFINED -

Enumeration Members

COMPONENT

COMPONENT: "COMPONENT"

MAC

MAC: "MAC"

NTSC

NTSC: "NTSC"

PAL

PAL: "PAL"

SECAM

SECAM: "SECAM"

UNDEFINED

UNDEFINED: "UNDEFINED"

Settings

Member Visibility

Theme

On This Page

COMPONENTMACNTSCPALSECAMUNDEFINED
\ No newline at end of file +

Enumeration Members

COMPONENT

COMPONENT: "COMPONENT"

MAC

MAC: "MAC"

NTSC

NTSC: "NTSC"

PAL

PAL: "PAL"

SECAM

SECAM: "SECAM"

UNDEFINED

UNDEFINED: "UNDEFINED"

Settings

Member Visibility

Theme

On This Page

COMPONENTMACNTSCPALSECAMUNDEFINED
\ No newline at end of file diff --git a/docs/enums/VorbisChannelLayout.html b/docs/enums/VorbisChannelLayout.html index 8a9c5f346..7df2ff52c 100644 --- a/docs/enums/VorbisChannelLayout.html +++ b/docs/enums/VorbisChannelLayout.html @@ -1,4 +1,4 @@ -VorbisChannelLayout | @bitmovin/api-sdk

Enumeration VorbisChannelLayout

Export

Enumeration Members

CL_2_1 +VorbisChannelLayout | @bitmovin/api-sdk

Enumeration VorbisChannelLayout

Export

Enumeration Members

CL_2_1 CL_2_2 CL_3_1 CL_4_0 @@ -9,4 +9,4 @@ CL_SURROUND MONO NONE -

Enumeration Members

CL_2_1

CL_2_1: "2.1"

CL_2_2

CL_2_2: "2.2"

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_5_1

CL_5_1: "5.1"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_2_1CL_2_2CL_3_1CL_4_0CL_5_1CL_5_1_BACKCL_QUADCL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file +

Enumeration Members

CL_2_1

CL_2_1: "2.1"

CL_2_2

CL_2_2: "2.2"

CL_3_1

CL_3_1: "3.1"

CL_4_0

CL_4_0: "4.0"

CL_5_1

CL_5_1: "5.1"

CL_5_1_BACK

CL_5_1_BACK: "5.1_BACK"

CL_QUAD

CL_QUAD: "QUAD"

CL_STEREO

CL_STEREO: "STEREO"

CL_SURROUND

CL_SURROUND: "SURROUND"

MONO

MONO: "MONO"

NONE

NONE: "NONE"

Settings

Member Visibility

Theme

On This Page

CL_2_1CL_2_2CL_3_1CL_4_0CL_5_1CL_5_1_BACKCL_QUADCL_STEREOCL_SURROUNDMONONONE
\ No newline at end of file diff --git a/docs/enums/Vp8ArnrType.html b/docs/enums/Vp8ArnrType.html index 8e54db2cb..9d47916a8 100644 --- a/docs/enums/Vp8ArnrType.html +++ b/docs/enums/Vp8ArnrType.html @@ -1,5 +1,5 @@ Vp8ArnrType | @bitmovin/api-sdk

Enumeration Vp8ArnrType

altref noise reduction filter type

-

Export

Enumeration Members

BACKWARD +

Export

Enumeration Members

BACKWARD CENTERED FORWARD -

Enumeration Members

BACKWARD

BACKWARD: "BACKWARD"

CENTERED

CENTERED: "CENTERED"

FORWARD

FORWARD: "FORWARD"

Settings

Member Visibility

Theme

On This Page

BACKWARDCENTEREDFORWARD
\ No newline at end of file +

Enumeration Members

BACKWARD

BACKWARD: "BACKWARD"

CENTERED

CENTERED: "CENTERED"

FORWARD

FORWARD: "FORWARD"

Settings

Member Visibility

Theme

On This Page

BACKWARDCENTEREDFORWARD
\ No newline at end of file diff --git a/docs/enums/Vp8NoiseSensitivity.html b/docs/enums/Vp8NoiseSensitivity.html index 495f2d1bc..182f08d0b 100644 --- a/docs/enums/Vp8NoiseSensitivity.html +++ b/docs/enums/Vp8NoiseSensitivity.html @@ -1,7 +1,7 @@ Vp8NoiseSensitivity | @bitmovin/api-sdk

Enumeration Vp8NoiseSensitivity

Noise sensitivity (frames to blur).

-

Export

Enumeration Members

ADAPTIVE +

Export

Enumeration Members

ADAPTIVE OFF ON_YUV ON_YUV_AGGRESSIVE ON_Y_ONLY -

Enumeration Members

ADAPTIVE

ADAPTIVE: "ADAPTIVE"

OFF

OFF: "OFF"

ON_YUV

ON_YUV: "ON_YUV"

ON_YUV_AGGRESSIVE

ON_YUV_AGGRESSIVE: "ON_YUV_AGGRESSIVE"

ON_Y_ONLY

ON_Y_ONLY: "ON_Y_ONLY"

Settings

Member Visibility

Theme

On This Page

ADAPTIVEOFFON_YUVON_YUV_AGGRESSIVEON_Y_ONLY
\ No newline at end of file +

Enumeration Members

ADAPTIVE

ADAPTIVE: "ADAPTIVE"

OFF

OFF: "OFF"

ON_YUV

ON_YUV: "ON_YUV"

ON_YUV_AGGRESSIVE

ON_YUV_AGGRESSIVE: "ON_YUV_AGGRESSIVE"

ON_Y_ONLY

ON_Y_ONLY: "ON_Y_ONLY"

Settings

Member Visibility

Theme

On This Page

ADAPTIVEOFFON_YUVON_YUV_AGGRESSIVEON_Y_ONLY
\ No newline at end of file diff --git a/docs/enums/Vp8Quality.html b/docs/enums/Vp8Quality.html index c1e0df943..8bc0653fe 100644 --- a/docs/enums/Vp8Quality.html +++ b/docs/enums/Vp8Quality.html @@ -1,5 +1,5 @@ Vp8Quality | @bitmovin/api-sdk

Enumeration Vp8Quality

Determines quality for the price of speed.

-

Export

Enumeration Members

BEST +

Export

Enumeration Members

BEST GOOD REALTIME -

Enumeration Members

BEST

BEST: "BEST"

GOOD

GOOD: "GOOD"

REALTIME

REALTIME: "REALTIME"

Settings

Member Visibility

Theme

On This Page

BESTGOODREALTIME
\ No newline at end of file +

Enumeration Members

BEST

BEST: "BEST"

GOOD

GOOD: "GOOD"

REALTIME

REALTIME: "REALTIME"

Settings

Member Visibility

Theme

On This Page

BESTGOODREALTIME
\ No newline at end of file diff --git a/docs/enums/Vp9AqMode.html b/docs/enums/Vp9AqMode.html index 9181a4f00..22aca65b2 100644 --- a/docs/enums/Vp9AqMode.html +++ b/docs/enums/Vp9AqMode.html @@ -1,6 +1,6 @@ Vp9AqMode | @bitmovin/api-sdk

Enumeration Vp9AqMode

Adaptive quantization mode.

-

Export

Enumeration Members

COMPLEXITY +

Export

Enumeration Members

COMPLEXITY CYCLIC NONE VARIANCE -

Enumeration Members

COMPLEXITY

COMPLEXITY: "COMPLEXITY"

CYCLIC

CYCLIC: "CYCLIC"

NONE

NONE: "NONE"

VARIANCE

VARIANCE: "VARIANCE"

Settings

Member Visibility

Theme

On This Page

COMPLEXITYCYCLICNONEVARIANCE
\ No newline at end of file +

Enumeration Members

COMPLEXITY

COMPLEXITY: "COMPLEXITY"

CYCLIC

CYCLIC: "CYCLIC"

NONE

NONE: "NONE"

VARIANCE

VARIANCE: "VARIANCE"

Settings

Member Visibility

Theme

On This Page

COMPLEXITYCYCLICNONEVARIANCE
\ No newline at end of file diff --git a/docs/enums/Vp9ArnrType.html b/docs/enums/Vp9ArnrType.html index b6f9f015e..1c8e5a4f7 100644 --- a/docs/enums/Vp9ArnrType.html +++ b/docs/enums/Vp9ArnrType.html @@ -1,5 +1,5 @@ Vp9ArnrType | @bitmovin/api-sdk

Enumeration Vp9ArnrType

altref noise reduction filter type

-

Export

Enumeration Members

BACKWARD +

Export

Enumeration Members

BACKWARD CENTERED FORWARD -

Enumeration Members

BACKWARD

BACKWARD: "BACKWARD"

CENTERED

CENTERED: "CENTERED"

FORWARD

FORWARD: "FORWARD"

Settings

Member Visibility

Theme

On This Page

BACKWARDCENTEREDFORWARD
\ No newline at end of file +

Enumeration Members

BACKWARD

BACKWARD: "BACKWARD"

CENTERED

CENTERED: "CENTERED"

FORWARD

FORWARD: "FORWARD"

Settings

Member Visibility

Theme

On This Page

BACKWARDCENTEREDFORWARD
\ No newline at end of file diff --git a/docs/enums/Vp9DynamicRangeFormat.html b/docs/enums/Vp9DynamicRangeFormat.html index ecd78b9b4..fde917387 100644 --- a/docs/enums/Vp9DynamicRangeFormat.html +++ b/docs/enums/Vp9DynamicRangeFormat.html @@ -1,4 +1,4 @@ Vp9DynamicRangeFormat | @bitmovin/api-sdk

Enumeration Vp9DynamicRangeFormat

Configures what kind of dynamic range the output should conform to. Can be used to convert from SDR to HLG, from HLG to SDR.

-

Export

Enumeration Members

HLG +

Export

Enumeration Members

HLG SDR -

Enumeration Members

HLG

HLG: "HLG"

SDR

SDR: "SDR"

Settings

Member Visibility

Theme

On This Page

HLGSDR
\ No newline at end of file +

Enumeration Members

HLG

HLG: "HLG"

SDR

SDR: "SDR"

Settings

Member Visibility

Theme

On This Page

HLGSDR
\ No newline at end of file diff --git a/docs/enums/Vp9Quality.html b/docs/enums/Vp9Quality.html index 3590961fa..45ea3a654 100644 --- a/docs/enums/Vp9Quality.html +++ b/docs/enums/Vp9Quality.html @@ -1,5 +1,5 @@ Vp9Quality | @bitmovin/api-sdk

Enumeration Vp9Quality

Determines quality for the price of speed.

-

Export

Enumeration Members

BEST +

Export

Enumeration Members

BEST GOOD REALTIME -

Enumeration Members

BEST

BEST: "BEST"

GOOD

GOOD: "GOOD"

REALTIME

REALTIME: "REALTIME"

Settings

Member Visibility

Theme

On This Page

BESTGOODREALTIME
\ No newline at end of file +

Enumeration Members

BEST

BEST: "BEST"

GOOD

GOOD: "GOOD"

REALTIME

REALTIME: "REALTIME"

Settings

Member Visibility

Theme

On This Page

BESTGOODREALTIME
\ No newline at end of file diff --git a/docs/enums/WatchFolderStatus.html b/docs/enums/WatchFolderStatus.html index 55d4ede3e..821fa6ff2 100644 --- a/docs/enums/WatchFolderStatus.html +++ b/docs/enums/WatchFolderStatus.html @@ -1,4 +1,4 @@ -WatchFolderStatus | @bitmovin/api-sdk

Enumeration WatchFolderStatus

Export

Enumeration Members

ERROR +WatchFolderStatus | @bitmovin/api-sdk

Enumeration WatchFolderStatus

Export

Enumeration Members

ERROR STARTED STOPPED -

Enumeration Members

ERROR

ERROR: "ERROR"

STARTED

STARTED: "STARTED"

STOPPED

STOPPED: "STOPPED"

Settings

Member Visibility

Theme

On This Page

ERRORSTARTEDSTOPPED
\ No newline at end of file +

Enumeration Members

ERROR

ERROR: "ERROR"

STARTED

STARTED: "STARTED"

STOPPED

STOPPED: "STOPPED"

Settings

Member Visibility

Theme

On This Page

ERRORSTARTEDSTOPPED
\ No newline at end of file diff --git a/docs/enums/WebVttCueIdentifierPolicy.html b/docs/enums/WebVttCueIdentifierPolicy.html index a4ede7977..31eab8d06 100644 --- a/docs/enums/WebVttCueIdentifierPolicy.html +++ b/docs/enums/WebVttCueIdentifierPolicy.html @@ -1,3 +1,3 @@ -WebVttCueIdentifierPolicy | @bitmovin/api-sdk

Enumeration WebVttCueIdentifierPolicy

Export

Enumeration Members

INCLUDE_IDENTIFIERS +WebVttCueIdentifierPolicy | @bitmovin/api-sdk

Enumeration WebVttCueIdentifierPolicy

Export

Enumeration Members

INCLUDE_IDENTIFIERS OMIT_IDENTIFIERS -

Enumeration Members

INCLUDE_IDENTIFIERS

INCLUDE_IDENTIFIERS: "INCLUDE_IDENTIFIERS"

OMIT_IDENTIFIERS

OMIT_IDENTIFIERS: "OMIT_IDENTIFIERS"

Settings

Member Visibility

Theme

On This Page

INCLUDE_IDENTIFIERSOMIT_IDENTIFIERS
\ No newline at end of file +

Enumeration Members

INCLUDE_IDENTIFIERS

INCLUDE_IDENTIFIERS: "INCLUDE_IDENTIFIERS"

OMIT_IDENTIFIERS

OMIT_IDENTIFIERS: "OMIT_IDENTIFIERS"

Settings

Member Visibility

Theme

On This Page

INCLUDE_IDENTIFIERSOMIT_IDENTIFIERS
\ No newline at end of file diff --git a/docs/enums/WebVttStylingMode.html b/docs/enums/WebVttStylingMode.html index d3651c30a..fecdf8886 100644 --- a/docs/enums/WebVttStylingMode.html +++ b/docs/enums/WebVttStylingMode.html @@ -1,4 +1,4 @@ WebVttStylingMode | @bitmovin/api-sdk

Enumeration WebVttStylingMode

Determines how WebVTT styling is handled.

-

Export

Enumeration Members

DROP_STYLING +

Export

Enumeration Members

DROP_STYLING PASSTHROUGH -

Enumeration Members

DROP_STYLING

DROP_STYLING: "DROP_STYLING"

PASSTHROUGH

PASSTHROUGH: "PASSTHROUGH"

Settings

Member Visibility

Theme

On This Page

DROP_STYLINGPASSTHROUGH
\ No newline at end of file +

Enumeration Members

DROP_STYLING

DROP_STYLING: "DROP_STYLING"

PASSTHROUGH

PASSTHROUGH: "PASSTHROUGH"

Settings

Member Visibility

Theme

On This Page

DROP_STYLINGPASSTHROUGH
\ No newline at end of file diff --git a/docs/enums/WebhookHttpMethod.html b/docs/enums/WebhookHttpMethod.html index bb74942b5..561bf2317 100644 --- a/docs/enums/WebhookHttpMethod.html +++ b/docs/enums/WebhookHttpMethod.html @@ -1,3 +1,3 @@ -WebhookHttpMethod | @bitmovin/api-sdk

Enumeration WebhookHttpMethod

Export

Enumeration Members

POST +WebhookHttpMethod | @bitmovin/api-sdk

Enumeration WebhookHttpMethod

Export

Enumeration Members

POST PUT -

Enumeration Members

POST

POST: "POST"

PUT

PUT: "PUT"

Settings

Member Visibility

Theme

On This Page

POSTPUT
\ No newline at end of file +

Enumeration Members

POST

POST: "POST"

PUT

PUT: "PUT"

Settings

Member Visibility

Theme

On This Page

POSTPUT
\ No newline at end of file diff --git a/docs/enums/WeightedPredictionPFrames.html b/docs/enums/WeightedPredictionPFrames.html index e20123424..4cf06e54a 100644 --- a/docs/enums/WeightedPredictionPFrames.html +++ b/docs/enums/WeightedPredictionPFrames.html @@ -1,5 +1,5 @@ WeightedPredictionPFrames | @bitmovin/api-sdk

Enumeration WeightedPredictionPFrames

Defines the mode for weighted prediction for P-frames

-

Export

Enumeration Members

DISABLED +

Export

Enumeration Members

DISABLED SIMPLE SMART -

Enumeration Members

DISABLED

DISABLED: "DISABLED"

SIMPLE

SIMPLE: "SIMPLE"

SMART

SMART: "SMART"

Settings

Member Visibility

Theme

On This Page

DISABLEDSIMPLESMART
\ No newline at end of file +

Enumeration Members

DISABLED

DISABLED: "DISABLED"

SIMPLE

SIMPLE: "SIMPLE"

SMART

SMART: "SMART"

Settings

Member Visibility

Theme

On This Page

DISABLEDSIMPLESMART
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 120e3c1a6..6f300b04c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@

Support

If you have any questions regarding the SDK, provided examples or our services, please log in to your Bitmovin Dashboard at https://bitmovin.com/dashboard and create a support ticket. Our team will get back to you as soon as possible :+1:

-

Installation

npm install @bitmovin/api-sdk@1.195.0
+
Installation
npm install @bitmovin/api-sdk@1.196.1
 

 
Initialization
Node
Using ES6 import

 
import BitmovinApi from '@bitmovin/api-sdk';
diff --git a/docs/interfaces/Configuration.html b/docs/interfaces/Configuration.html
index cf48e6310..70534d37e 100644
--- a/docs/interfaces/Configuration.html
+++ b/docs/interfaces/Configuration.html
@@ -1,7 +1,7 @@
-Configuration | @bitmovin/api-sdk
Interface Configuration
interface Configuration { 
    apiKey: string; 
    baseUrl?: string; 
    fetch?: FetchAPI; 
    headers?: Record<string, string>; 
    logger?: Logger; 
    tenantOrgId?: string; 
}
Properties
apiKey
+Configuration | @bitmovin/api-sdk
Interface Configuration
interface Configuration { 
    apiKey: string; 
    baseUrl?: string; 
    fetch?: FetchAPI; 
    headers?: Record<string, string>; 
    logger?: Logger; 
    tenantOrgId?: string; 
}
Properties
apiKey
 baseUrl?
 fetch?
 headers?
 logger?
 tenantOrgId?
-
Properties
apiKey
apiKey: string
Optional baseUrl
baseUrl?: string
Optional fetch
fetch?: FetchAPI
Optional headers
headers?: Record<string, string>
Optional logger
logger?: Logger
Optional tenantOrgId
tenantOrgId?: string
Settings
Member Visibility
Theme
On This Page
apiKeybaseUrlfetchheadersloggertenantOrgId

\ No newline at end of file
+
Properties
apiKey
apiKey: string
Optional baseUrl
baseUrl?: string
Optional fetch
fetch?: FetchAPI
Optional headers
headers?: Record<string, string>
Optional logger
logger?: Logger
Optional tenantOrgId
tenantOrgId?: string
Settings
Member Visibility
Theme
On This Page
apiKeybaseUrlfetchheadersloggertenantOrgId

\ No newline at end of file
diff --git a/docs/types/AbstractConditionUnion.html b/docs/types/AbstractConditionUnion.html
index 66b222aa6..b55731939 100644
--- a/docs/types/AbstractConditionUnion.html
+++ b/docs/types/AbstractConditionUnion.html
@@ -1 +1 @@
-AbstractConditionUnion | @bitmovin/api-sdk
Type alias AbstractConditionUnion
AbstractConditionUnion: Condition | AndConjunction | OrConjunction
Settings
Member Visibility
Theme

\ No newline at end of file
+AbstractConditionUnion | @bitmovin/api-sdk
Type alias AbstractConditionUnion
AbstractConditionUnion: Condition | AndConjunction | OrConjunction
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/AdAnalyticsAbstractFilterUnion.html b/docs/types/AdAnalyticsAbstractFilterUnion.html
index 7536cc966..35066fce0 100644
--- a/docs/types/AdAnalyticsAbstractFilterUnion.html
+++ b/docs/types/AdAnalyticsAbstractFilterUnion.html
@@ -1 +1 @@
-AdAnalyticsAbstractFilterUnion | @bitmovin/api-sdk
Type alias AdAnalyticsAbstractFilterUnion
AdAnalyticsAbstractFilterUnion: AdAnalyticsInFilter | AdAnalyticsEqualFilter | AdAnalyticsNotEqualFilter | AdAnalyticsLessThanFilter | AdAnalyticsLessThanOrEqualFilter | AdAnalyticsGreaterThanFilter | AdAnalyticsGreaterThanOrEqualFilter | AdAnalyticsContainsFilter | AdAnalyticsNotContainsFilter
Settings
Member Visibility
Theme

\ No newline at end of file
+AdAnalyticsAbstractFilterUnion | @bitmovin/api-sdk
Type alias AdAnalyticsAbstractFilterUnion
AdAnalyticsAbstractFilterUnion: AdAnalyticsInFilter | AdAnalyticsEqualFilter | AdAnalyticsNotEqualFilter | AdAnalyticsLessThanFilter | AdAnalyticsLessThanOrEqualFilter | AdAnalyticsGreaterThanFilter | AdAnalyticsGreaterThanOrEqualFilter | AdAnalyticsContainsFilter | AdAnalyticsNotContainsFilter
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/AdaptationSetUnion.html b/docs/types/AdaptationSetUnion.html
index ccc137dd3..eac12a3a1 100644
--- a/docs/types/AdaptationSetUnion.html
+++ b/docs/types/AdaptationSetUnion.html
@@ -1 +1 @@
-AdaptationSetUnion | @bitmovin/api-sdk
Type alias AdaptationSetUnion
AdaptationSetUnion: VideoAdaptationSet | AudioAdaptationSet | ImageAdaptationSet | SubtitleAdaptationSet
Settings
Member Visibility
Theme

\ No newline at end of file
+AdaptationSetUnion | @bitmovin/api-sdk
Type alias AdaptationSetUnion
AdaptationSetUnion: VideoAdaptationSet | AudioAdaptationSet | ImageAdaptationSet | SubtitleAdaptationSet
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/AnalyticsAbstractFilterUnion.html b/docs/types/AnalyticsAbstractFilterUnion.html
index 94f15afc6..5d360208d 100644
--- a/docs/types/AnalyticsAbstractFilterUnion.html
+++ b/docs/types/AnalyticsAbstractFilterUnion.html
@@ -1 +1 @@
-AnalyticsAbstractFilterUnion | @bitmovin/api-sdk
Type alias AnalyticsAbstractFilterUnion
AnalyticsAbstractFilterUnion: AnalyticsInFilter | AnalyticsEqualFilter | AnalyticsNotEqualFilter | AnalyticsLessThanFilter | AnalyticsLessThanOrEqualFilter | AnalyticsGreaterThanFilter | AnalyticsGreaterThanOrEqualFilter | AnalyticsContainsFilter | AnalyticsNotContainsFilter
Settings
Member Visibility
Theme

\ No newline at end of file
+AnalyticsAbstractFilterUnion | @bitmovin/api-sdk
Type alias AnalyticsAbstractFilterUnion
AnalyticsAbstractFilterUnion: AnalyticsInFilter | AnalyticsEqualFilter | AnalyticsNotEqualFilter | AnalyticsLessThanFilter | AnalyticsLessThanOrEqualFilter | AnalyticsGreaterThanFilter | AnalyticsGreaterThanOrEqualFilter | AnalyticsContainsFilter | AnalyticsNotContainsFilter
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/AnalyticsOutputUnion.html b/docs/types/AnalyticsOutputUnion.html
index e30960c25..e96a033a2 100644
--- a/docs/types/AnalyticsOutputUnion.html
+++ b/docs/types/AnalyticsOutputUnion.html
@@ -1 +1 @@
-AnalyticsOutputUnion | @bitmovin/api-sdk
Type alias AnalyticsOutputUnion
AnalyticsOutputUnion: AnalyticsS3RoleBasedOutput | AnalyticsGcsServiceAccountOutput | AnalyticsAzureOutput
Settings
Member Visibility
Theme

\ No newline at end of file
+AnalyticsOutputUnion | @bitmovin/api-sdk
Type alias AnalyticsOutputUnion
AnalyticsOutputUnion: AnalyticsS3RoleBasedOutput | AnalyticsGcsServiceAccountOutput | AnalyticsAzureOutput
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/CodecConfigurationUnion.html b/docs/types/CodecConfigurationUnion.html
index a29b52304..dbb9ef17c 100644
--- a/docs/types/CodecConfigurationUnion.html
+++ b/docs/types/CodecConfigurationUnion.html
@@ -1 +1 @@
-CodecConfigurationUnion | @bitmovin/api-sdk
Type alias CodecConfigurationUnion
CodecConfigurationUnion: AacAudioConfiguration | PassthroughAudioConfiguration | DtsPassthroughAudioConfiguration | DtsAudioConfiguration | DtsXAudioConfiguration | DvbSubtitleConfiguration | HeAacV1AudioConfiguration | HeAacV2AudioConfiguration | H264VideoConfiguration | H265VideoConfiguration | Vp9VideoConfiguration | Vp8VideoConfiguration | Mp2AudioConfiguration | Mp3AudioConfiguration | Ac3AudioConfiguration | DolbyDigitalAudioConfiguration | Eac3AudioConfiguration | DolbyDigitalPlusAudioConfiguration | OpusAudioConfiguration | VorbisAudioConfiguration | MjpegVideoConfiguration | Av1VideoConfiguration | DolbyAtmosAudioConfiguration | H262VideoConfiguration | PcmAudioConfiguration | WebVttConfiguration | ImscConfiguration
Settings
Member Visibility
Theme

\ No newline at end of file
+CodecConfigurationUnion | @bitmovin/api-sdk
Type alias CodecConfigurationUnion
CodecConfigurationUnion: AacAudioConfiguration | PassthroughAudioConfiguration | DtsPassthroughAudioConfiguration | DtsAudioConfiguration | DtsXAudioConfiguration | DvbSubtitleConfiguration | HeAacV1AudioConfiguration | HeAacV2AudioConfiguration | H264VideoConfiguration | H265VideoConfiguration | Vp9VideoConfiguration | Vp8VideoConfiguration | Mp2AudioConfiguration | Mp3AudioConfiguration | Ac3AudioConfiguration | DolbyDigitalAudioConfiguration | Eac3AudioConfiguration | DolbyDigitalPlusAudioConfiguration | OpusAudioConfiguration | VorbisAudioConfiguration | MjpegVideoConfiguration | Av1VideoConfiguration | DolbyAtmosAudioConfiguration | H262VideoConfiguration | PcmAudioConfiguration | WebVttConfiguration | ImscConfiguration
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/DashRepresentationUnion.html b/docs/types/DashRepresentationUnion.html
index ddff71d95..22a4491d3 100644
--- a/docs/types/DashRepresentationUnion.html
+++ b/docs/types/DashRepresentationUnion.html
@@ -1 +1 @@
-DashRepresentationUnion | @bitmovin/api-sdk
Type alias DashRepresentationUnion
DashRepresentationUnion: DashFmp4DrmRepresentation | DashFmp4Representation | DashWebmRepresentation | DashCmafRepresentation | DashChunkedTextRepresentation | DashMp4Representation | DashMp4DrmRepresentation | DashProgressiveWebmRepresentation | DashVttRepresentation | SpriteRepresentation | DashImscRepresentation | ContentProtection
Settings
Member Visibility
Theme

\ No newline at end of file
+DashRepresentationUnion | @bitmovin/api-sdk
Type alias DashRepresentationUnion
DashRepresentationUnion: DashFmp4DrmRepresentation | DashFmp4Representation | DashWebmRepresentation | DashCmafRepresentation | DashChunkedTextRepresentation | DashMp4Representation | DashMp4DrmRepresentation | DashProgressiveWebmRepresentation | DashVttRepresentation | SpriteRepresentation | DashImscRepresentation | ContentProtection
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/DefaultManifestConditionUnion.html b/docs/types/DefaultManifestConditionUnion.html
index 49114aae4..9b4a4fe91 100644
--- a/docs/types/DefaultManifestConditionUnion.html
+++ b/docs/types/DefaultManifestConditionUnion.html
@@ -1 +1 @@
-DefaultManifestConditionUnion | @bitmovin/api-sdk
Type alias DefaultManifestConditionUnion
DefaultManifestConditionUnion: DefaultManifestAttributeCondition | DefaultManifestAndCondition | DefaultManifestOrCondition
Settings
Member Visibility
Theme

\ No newline at end of file
+DefaultManifestConditionUnion | @bitmovin/api-sdk
Type alias DefaultManifestConditionUnion
DefaultManifestConditionUnion: DefaultManifestAttributeCondition | DefaultManifestAndCondition | DefaultManifestOrCondition
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/DrmUnion.html b/docs/types/DrmUnion.html
index ca0092fb5..c6e129967 100644
--- a/docs/types/DrmUnion.html
+++ b/docs/types/DrmUnion.html
@@ -1 +1 @@
-DrmUnion | @bitmovin/api-sdk
Type alias DrmUnion
DrmUnion: WidevineDrm | PlayReadyDrm | PrimeTimeDrm | FairPlayDrm | MarlinDrm | ClearKeyDrm | AesEncryptionDrm | CencDrm | SpekeDrm
Settings
Member Visibility
Theme

\ No newline at end of file
+DrmUnion | @bitmovin/api-sdk
Type alias DrmUnion
DrmUnion: WidevineDrm | PlayReadyDrm | PrimeTimeDrm | FairPlayDrm | MarlinDrm | ClearKeyDrm | AesEncryptionDrm | CencDrm | SpekeDrm
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/FilterUnion.html b/docs/types/FilterUnion.html
index d38a54a08..0d82bb5a6 100644
--- a/docs/types/FilterUnion.html
+++ b/docs/types/FilterUnion.html
@@ -1 +1 @@
-FilterUnion | @bitmovin/api-sdk
Type alias FilterUnion
FilterUnion: CropFilter | ConformFilter | WatermarkFilter | EnhancedWatermarkFilter | RotateFilter | DeinterlaceFilter | EnhancedDeinterlaceFilter | AudioMixFilter | DenoiseHqdn3dFilter | TextFilter | UnsharpFilter | ScaleFilter | InterlaceFilter | AudioVolumeFilter | EbuR128SinglePassFilter | AzureSpeechToCaptionsFilter
Settings
Member Visibility
Theme

\ No newline at end of file
+FilterUnion | @bitmovin/api-sdk
Type alias FilterUnion
FilterUnion: CropFilter | ConformFilter | WatermarkFilter | EnhancedWatermarkFilter | RotateFilter | DeinterlaceFilter | EnhancedDeinterlaceFilter | AudioMixFilter | DenoiseHqdn3dFilter | TextFilter | UnsharpFilter | ScaleFilter | InterlaceFilter | AudioVolumeFilter | EbuR128SinglePassFilter | AzureSpeechToCaptionsFilter
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/Id3TagUnion.html b/docs/types/Id3TagUnion.html
index e68974bc9..41692067e 100644
--- a/docs/types/Id3TagUnion.html
+++ b/docs/types/Id3TagUnion.html
@@ -1 +1 @@
-Id3TagUnion | @bitmovin/api-sdk
Type alias Id3TagUnion
Id3TagUnion: RawId3Tag | FrameIdId3Tag | PlaintextId3Tag
Settings
Member Visibility
Theme

\ No newline at end of file
+Id3TagUnion | @bitmovin/api-sdk
Type alias Id3TagUnion
Id3TagUnion: RawId3Tag | FrameIdId3Tag | PlaintextId3Tag
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/InputStreamUnion.html b/docs/types/InputStreamUnion.html
index fae68f5df..ab79485cf 100644
--- a/docs/types/InputStreamUnion.html
+++ b/docs/types/InputStreamUnion.html
@@ -1 +1 @@
-InputStreamUnion | @bitmovin/api-sdk
Type alias InputStreamUnion
InputStreamUnion: IngestInputStream | ConcatenationInputStream | TimeBasedTrimmingInputStream | TimecodeTrackTrimmingInputStream | H264PictureTimingTrimmingInputStream | AudioMixInputStream | DolbyVisionMetadataIngestInputStream | Cea608CaptionInputStream | Cea708CaptionInputStream | FileInputStream | DvbSubtitleInputStream | DolbyAtmosIngestInputStream | DolbyVisionInputStream
Settings
Member Visibility
Theme

\ No newline at end of file
+InputStreamUnion | @bitmovin/api-sdk
Type alias InputStreamUnion
InputStreamUnion: IngestInputStream | ConcatenationInputStream | TimeBasedTrimmingInputStream | TimecodeTrackTrimmingInputStream | H264PictureTimingTrimmingInputStream | AudioMixInputStream | DolbyVisionMetadataIngestInputStream | Cea608CaptionInputStream | Cea708CaptionInputStream | FileInputStream | DvbSubtitleInputStream | DolbyAtmosIngestInputStream | DolbyVisionInputStream
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/InputUnion.html b/docs/types/InputUnion.html
index 63a58e37c..0c0fc1b53 100644
--- a/docs/types/InputUnion.html
+++ b/docs/types/InputUnion.html
@@ -1 +1 @@
-InputUnion | @bitmovin/api-sdk
Type alias InputUnion
InputUnion: AkamaiNetStorageInput | AsperaInput | AzureInput | RedundantRtmpInput | FtpInput | GenericS3Input | GcsInput | HttpInput | HttpsInput | LocalInput | RtmpInput | S3Input | S3RoleBasedInput | SftpInput | ZixiInput | SrtInput | GcsServiceAccountInput | DirectFileUploadInput
Settings
Member Visibility
Theme

\ No newline at end of file
+InputUnion | @bitmovin/api-sdk
Type alias InputUnion
InputUnion: AkamaiNetStorageInput | AsperaInput | AzureInput | RedundantRtmpInput | FtpInput | GenericS3Input | GcsInput | HttpInput | HttpsInput | LocalInput | RtmpInput | S3Input | S3RoleBasedInput | SftpInput | ZixiInput | SrtInput | GcsServiceAccountInput | DirectFileUploadInput
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/MuxingUnion.html b/docs/types/MuxingUnion.html
index 096adcacf..001b3b47e 100644
--- a/docs/types/MuxingUnion.html
+++ b/docs/types/MuxingUnion.html
@@ -1 +1 @@
-MuxingUnion | @bitmovin/api-sdk
Type alias MuxingUnion
MuxingUnion: Fmp4Muxing | CmafMuxing | Mp4Muxing | TsMuxing | WebmMuxing | Mp3Muxing | MxfMuxing | ProgressiveWebmMuxing | ProgressiveMovMuxing | ProgressiveTsMuxing | BroadcastTsMuxing | ChunkedTextMuxing | TextMuxing | SegmentedRawMuxing | PackedAudioMuxing
Settings
Member Visibility
Theme

\ No newline at end of file
+MuxingUnion | @bitmovin/api-sdk
Type alias MuxingUnion
MuxingUnion: Fmp4Muxing | CmafMuxing | Mp4Muxing | TsMuxing | WebmMuxing | Mp3Muxing | MxfMuxing | ProgressiveWebmMuxing | ProgressiveMovMuxing | ProgressiveTsMuxing | BroadcastTsMuxing | ChunkedTextMuxing | TextMuxing | SegmentedRawMuxing | PackedAudioMuxing
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/OutputUnion.html b/docs/types/OutputUnion.html
index 9d86ab894..d0e1720ad 100644
--- a/docs/types/OutputUnion.html
+++ b/docs/types/OutputUnion.html
@@ -1 +1 @@
-OutputUnion | @bitmovin/api-sdk
Type alias OutputUnion
OutputUnion: AkamaiNetStorageOutput | AzureOutput | CdnOutput | GenericS3Output | GcsOutput | FtpOutput | LocalOutput | S3Output | S3RoleBasedOutput | SftpOutput | AkamaiMslOutput | LiveMediaIngestOutput | GcsServiceAccountOutput
Settings
Member Visibility
Theme

\ No newline at end of file
+OutputUnion | @bitmovin/api-sdk
Type alias OutputUnion
OutputUnion: AkamaiNetStorageOutput | AzureOutput | CdnOutput | GenericS3Output | GcsOutput | FtpOutput | LocalOutput | S3Output | S3RoleBasedOutput | SftpOutput | AkamaiMslOutput | LiveMediaIngestOutput | GcsServiceAccountOutput
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/SidecarFileUnion.html b/docs/types/SidecarFileUnion.html
index 643da185a..123d94749 100644
--- a/docs/types/SidecarFileUnion.html
+++ b/docs/types/SidecarFileUnion.html
@@ -1 +1 @@
-SidecarFileUnion | @bitmovin/api-sdk
Type alias SidecarFileUnion
SidecarFileUnion: WebVttSidecarFile
Settings
Member Visibility
Theme

\ No newline at end of file
+SidecarFileUnion | @bitmovin/api-sdk
Type alias SidecarFileUnion
SidecarFileUnion: WebVttSidecarFile
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/SimpleEncodingLiveJobOutputUnion.html b/docs/types/SimpleEncodingLiveJobOutputUnion.html
index 2bd8dcac4..c230249ff 100644
--- a/docs/types/SimpleEncodingLiveJobOutputUnion.html
+++ b/docs/types/SimpleEncodingLiveJobOutputUnion.html
@@ -1 +1 @@
-SimpleEncodingLiveJobOutputUnion | @bitmovin/api-sdk
Type alias SimpleEncodingLiveJobOutputUnion
SimpleEncodingLiveJobOutputUnion: SimpleEncodingLiveJobUrlOutput | SimpleEncodingLiveJobCdnOutput
Settings
Member Visibility
Theme

\ No newline at end of file
+SimpleEncodingLiveJobOutputUnion | @bitmovin/api-sdk
Type alias SimpleEncodingLiveJobOutputUnion
SimpleEncodingLiveJobOutputUnion: SimpleEncodingLiveJobUrlOutput | SimpleEncodingLiveJobCdnOutput
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/SimpleEncodingVodJobInputUnion.html b/docs/types/SimpleEncodingVodJobInputUnion.html
index 2ba52d9c0..39c0694a8 100644
--- a/docs/types/SimpleEncodingVodJobInputUnion.html
+++ b/docs/types/SimpleEncodingVodJobInputUnion.html
@@ -1 +1 @@
-SimpleEncodingVodJobInputUnion | @bitmovin/api-sdk
Type alias SimpleEncodingVodJobInputUnion
SimpleEncodingVodJobInputUnion: SimpleEncodingVodJobUrlInput | SimpleEncodingVodJobDirectFileUploadInput
Settings
Member Visibility
Theme

\ No newline at end of file
+SimpleEncodingVodJobInputUnion | @bitmovin/api-sdk
Type alias SimpleEncodingVodJobInputUnion
SimpleEncodingVodJobInputUnion: SimpleEncodingVodJobUrlInput | SimpleEncodingVodJobDirectFileUploadInput
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/SimpleEncodingVodJobOutputUnion.html b/docs/types/SimpleEncodingVodJobOutputUnion.html
index 4db13f242..d62b21cad 100644
--- a/docs/types/SimpleEncodingVodJobOutputUnion.html
+++ b/docs/types/SimpleEncodingVodJobOutputUnion.html
@@ -1 +1 @@
-SimpleEncodingVodJobOutputUnion | @bitmovin/api-sdk
Type alias SimpleEncodingVodJobOutputUnion
SimpleEncodingVodJobOutputUnion: SimpleEncodingVodJobUrlOutput | SimpleEncodingVodJobCdnOutput
Settings
Member Visibility
Theme

\ No newline at end of file
+SimpleEncodingVodJobOutputUnion | @bitmovin/api-sdk
Type alias SimpleEncodingVodJobOutputUnion
SimpleEncodingVodJobOutputUnion: SimpleEncodingVodJobUrlOutput | SimpleEncodingVodJobCdnOutput
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/docs/types/StreamsResponseUnion.html b/docs/types/StreamsResponseUnion.html
index f85708253..e4b6ae697 100644
--- a/docs/types/StreamsResponseUnion.html
+++ b/docs/types/StreamsResponseUnion.html
@@ -1 +1 @@
-StreamsResponseUnion | @bitmovin/api-sdk
Type alias StreamsResponseUnion
StreamsResponseUnion: StreamsVideoResponse | StreamsLiveResponse
Settings
Member Visibility
Theme

\ No newline at end of file
+StreamsResponseUnion | @bitmovin/api-sdk
Type alias StreamsResponseUnion
StreamsResponseUnion: StreamsVideoResponse | StreamsLiveResponse
Settings
Member Visibility
Theme

\ No newline at end of file
diff --git a/package.json b/package.json
index f1bdb2fc6..f7f67c649 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@bitmovin/api-sdk",
-  "version": "1.195.0",
+  "version": "1.196.1",
   "description": "Bitmovin JS/TS API SDK",
   "author": "Bitmovin Inc",
   "keywords": [
diff --git a/src/common/RestClient.ts b/src/common/RestClient.ts
index 3a06793a0..a95a549fb 100644
--- a/src/common/RestClient.ts
+++ b/src/common/RestClient.ts
@@ -233,7 +233,7 @@ class HeaderHandler extends DelegatingHandler {
     const headers: Record = {
       'X-Api-Key': apiKey,
       'X-Api-Client': 'bitmovin-api-sdk-javascript',
-      'X-Api-Client-Version': '1.195.0',
+      'X-Api-Client-Version': '1.196.1',
       'Content-Type': 'application/json'
     };
 
diff --git a/src/models/DashSegmentedRepresentation.ts b/src/models/DashSegmentedRepresentation.ts
index 75fa29d38..9d9f8f8c1 100644
--- a/src/models/DashSegmentedRepresentation.ts
+++ b/src/models/DashSegmentedRepresentation.ts
@@ -42,14 +42,14 @@ export class DashSegmentedRepresentation extends DashMuxingRepresentation {
   public endSegmentNumber?: number;
 
   /**
-   * Id of the Keyframe to start with
+   * Id of the keyframe to start with. It takes precedence over startSegmentNumber
    * @type {string}
    * @memberof DashSegmentedRepresentation
    */
   public startKeyframeId?: string;
 
   /**
-   * Id of the Keyframe to end with
+   * Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.
    * @type {string}
    * @memberof DashSegmentedRepresentation
    */