Class StreamKey

Export

StreamKey

Hierarchy (view full)

Constructors

constructor

Properties

assignedEncodingId? assignedIngestPointId? createdAt? customData? description? id? modifiedAt? name? 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

Memberof

StreamKey

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

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 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 status

status?: StreamKeyStatus

Status of the stream key

Memberof

StreamKey

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.

Memberof

StreamKey

Settings

Member Visibility

Theme

On This Page

constructorassignedEncodingIdassignedIngestPointIdcreatedAtcustomDatadescriptionidmodifiedAtnamestatustypevalue