Class EncodingsApi

Hierarchy

BaseAPI
BaseAPI
BaseAPI
BaseAPI
- EncodingsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EncodingsApi(configuration: Configuration): EncodingsApi

Overrides BaseAPI.constructor
- Defined in encoding/encodings/EncodingsApi.ts:41
Parameters
- configuration: Configuration
Returns EncodingsApi

Properties

captions

captions: CaptionsApi

customdata

customdata: CustomdataApi

encodingStatusChanged

encodingStatusChanged: EncodingStatusChangedApi

error

error: ErrorApi

finished

finished: FinishedApi

inputStreams

inputStreams: InputStreamsApi

keyframes

keyframes: KeyframesApi

live

live: LiveApi

liveInputStreamChanged

liveInputStreamChanged: LiveInputStreamChangedApi

liveStatistics

liveStatistics: LiveStatisticsApi

machineLearning

machineLearning: MachineLearningApi

muxings

muxings: MuxingsApi

Protected restClient

restClient: RestClient

sidecars

sidecars: SidecarsApi

streams

streams: StreamsApi

transferError

transferError: TransferErrorApi

transferRetries

transferRetries: TransferRetriesApi

vod

Methods

create

create(encoding: Encoding): Promise<Encoding>

- Defined in encoding/encodings/EncodingsApi.ts:63
Parameters
- Optional encoding: Encoding
Returns Promise<Encoding>

delete

delete(encodingId: string): Promise<BitmovinResponse>

- Defined in encoding/encodings/EncodingsApi.ts:75
Parameters
- encodingId: string
Returns Promise<BitmovinResponse>

get

get(encodingId: string): Promise<Encoding>

- Defined in encoding/encodings/EncodingsApi.ts:90
Parameters
- encodingId: string
Returns Promise<Encoding>

getStartRequest

getStartRequest(encodingId: string): Promise<StartEncodingRequest>

- Defined in encoding/encodings/EncodingsApi.ts:105
Parameters
- encodingId: string
Returns Promise<StartEncodingRequest>

list

list(queryParameters: EncodingListQueryParams | function): Promise<PaginationResponse<Encoding>>

- Defined in encoding/encodings/EncodingsApi.ts:120
Parameters
- Optional queryParameters: EncodingListQueryParams | function
Returns Promise<PaginationResponse<Encoding>>

reprioritize

reprioritize(encodingId: string, reprioritizeEncodingRequest: ReprioritizeEncodingRequest): Promise<BitmovinResponse>

- Defined in encoding/encodings/EncodingsApi.ts:139
Parameters
- encodingId: string
- Optional reprioritizeEncodingRequest: ReprioritizeEncodingRequest
Returns Promise<BitmovinResponse>

reschedule

reschedule(encodingId: string, rescheduleEncodingRequest: RescheduleEncodingRequest): Promise<BitmovinResponse>

- Defined in encoding/encodings/EncodingsApi.ts:155
Parameters
- encodingId: string
- Optional rescheduleEncodingRequest: RescheduleEncodingRequest
Returns Promise<BitmovinResponse>

start

start(encodingId: string, startEncodingRequest: StartEncodingRequest): Promise<BitmovinResponse>

- Defined in encoding/encodings/EncodingsApi.ts:171
Parameters
- encodingId: string
- Optional startEncodingRequest: StartEncodingRequest
Returns Promise<BitmovinResponse>

status

status(encodingId: string): Promise<Task>

- Defined in encoding/encodings/EncodingsApi.ts:186
Parameters
- encodingId: string
Returns Promise<Task>

stop

stop(encodingId: string): Promise<BitmovinResponse>

- Defined in encoding/encodings/EncodingsApi.ts:201
Parameters
- encodingId: string
Returns Promise<BitmovinResponse>

Generated using TypeDoc