Class LiveStandbyPoolDetails

Export

LiveStandbyPoolDetails

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? encodingTemplate? encodingTemplateName? errorEncodings? id? modifiedAt? name? poolStatus? preparingEncodings? readyEncodings? targetPoolSize?

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.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

Optional description

description?: string

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

Memberof

BitmovinResource

Optional encodingTemplate

encodingTemplate?: string

Base64 encoded template used to start the encodings in the pool

Memberof

LiveStandbyPoolDetails

Optional encodingTemplateName

encodingTemplateName?: string

The name of the encoding template used with this Standby Pool

Memberof

LiveStandbyPoolResponse

Optional errorEncodings

errorEncodings?: number

Number of instances currently in error state in the pool

Memberof

LiveStandbyPoolResponse

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

Memberof

BitmovinResource

Optional name

name?: string

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

Memberof

BitmovinResource

Optional poolStatus

poolStatus?: LiveStandbyPoolStatus

Memberof

LiveStandbyPoolResponse

Optional preparingEncodings

preparingEncodings?: number

Number of instances currently being prepared in the pool

Memberof

LiveStandbyPoolResponse

Optional readyEncodings

readyEncodings?: number

Number of instances currently in ready state in the pool

Memberof

LiveStandbyPoolResponse

Optional targetPoolSize

targetPoolSize?: number

Number of instances to keep ready for streaming while the pool is running (required)

Memberof

LiveStandbyPoolResponse

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionencodingTemplateencodingTemplateNameerrorEncodingsidmodifiedAtnamepoolStatuspreparingEncodingsreadyEncodingstargetPoolSize