Class LiveApi

Hierarchy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LiveApi(configuration: Configuration): LiveApi

Overrides BaseAPI.constructor
- Defined in encoding/encodings/live/LiveApi.ts:18
Parameters
- configuration: Configuration
Returns LiveApi

Properties

daily

daily: DailyApi

insertableContent

insertableContent: InsertableContentApi

Protected restClient

restClient: RestClient

scte35Cue

scte35Cue: Scte35CueApi

Methods

create

create(simpleEncodingLiveJobRequest: SimpleEncodingLiveJobRequest): Promise<SimpleEncodingLiveJobResponse>

- Defined in encoding/simple/jobs/live/LiveApi.ts:25
Parameters
- Optional simpleEncodingLiveJobRequest: SimpleEncodingLiveJobRequest
Returns Promise<SimpleEncodingLiveJobResponse>

get

get(encodingId: string): Promise<LiveEncoding>

- Defined in encoding/encodings/live/LiveApi.ts:32
Parameters
- encodingId: string
Returns Promise<LiveEncoding>

getStartRequest

getStartRequest(encodingId: string): Promise<StartLiveEncodingRequest>

- Defined in encoding/encodings/live/LiveApi.ts:47
Parameters
- encodingId: string
Returns Promise<StartLiveEncodingRequest>

list

list(queryParameters: EncodingStatisticsLiveListQueryParams | function): Promise<PaginationResponse<EncodingStatisticsLive>>

- Defined in encoding/statistics/encodings/live/LiveApi.ts:30
Parameters
- Optional queryParameters: EncodingStatisticsLiveListQueryParams | function
Returns Promise<PaginationResponse<EncodingStatisticsLive>>

listByDateRange

listByDateRange(from: Date, to: Date, queryParameters: EncodingStatisticsLiveListByDateRangeQueryParams | function): Promise<PaginationResponse<EncodingStatisticsLive>>

- Defined in encoding/statistics/encodings/live/LiveApi.ts:50
Parameters
- from: Date
- to: Date
- Optional queryParameters: EncodingStatisticsLiveListByDateRangeQueryParams | function
Returns Promise<PaginationResponse<EncodingStatisticsLive>>

restart

restart(encodingId: string): Promise<BitmovinResponse>

- Defined in encoding/encodings/live/LiveApi.ts:62
Parameters
- encodingId: string
Returns Promise<BitmovinResponse>

start

start(encodingId: string, startLiveEncodingRequest: StartLiveEncodingRequest): Promise<BitmovinResponse>

- Defined in encoding/encodings/live/LiveApi.ts:78
Parameters
- encodingId: string
- Optional startLiveEncodingRequest: StartLiveEncodingRequest
Returns Promise<BitmovinResponse>

stop

stop(encodingId: string): Promise<BitmovinResponse>

- Defined in encoding/encodings/live/LiveApi.ts:93
Parameters
- encodingId: string
Returns Promise<BitmovinResponse>

Generated using TypeDoc