Class SccApi

Hierarchy

BaseAPI
BaseAPI
- SccApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SccApi(configuration: Configuration): SccApi

Overrides BaseAPI.constructor
- Defined in encoding/encodings/streams/captions/cea/scc/SccApi.ts:17
Parameters
- configuration: Configuration
Returns SccApi

Properties

customdata

customdata: CustomdataApi

Protected restClient

restClient: RestClient

Methods

create

create(encodingId: string, streamId: string, sccCaption: SccCaption): Promise<SccCaption>

- Defined in encoding/encodings/streams/captions/cea/scc/SccApi.ts:32
Parameters
- encodingId: string
- streamId: string
- Optional sccCaption: SccCaption
Returns Promise<SccCaption>

delete

delete(encodingId: string, streamId: string, captionsId: string): Promise<BitmovinResponse>

- Defined in encoding/encodings/streams/captions/cea/scc/SccApi.ts:50
Parameters
- encodingId: string
- streamId: string
- captionsId: string
Returns Promise<BitmovinResponse>

get

get(encodingId: string, streamId: string, captionsId: string): Promise<SccCaption>

- Defined in encoding/encodings/streams/captions/cea/scc/SccApi.ts:69
Parameters
- encodingId: string
- streamId: string
- captionsId: string
Returns Promise<SccCaption>

list

list(encodingId: string, streamId: string, queryParameters: SccCaptionListQueryParams | function): Promise<PaginationResponse<SccCaption>>

- Defined in encoding/encodings/streams/captions/cea/scc/SccApi.ts:88
Parameters
- encodingId: string
- streamId: string
- Optional queryParameters: SccCaptionListQueryParams | function
Returns Promise<PaginationResponse<SccCaption>>

Generated using TypeDoc