Class ClosedCaptionsApi

Hierarchy

BaseAPI
- ClosedCaptionsApi

Index

Constructors

constructor

Properties

restClient

Methods

Constructors

constructor

new ClosedCaptionsApi(configuration: Configuration): ClosedCaptionsApi

Overrides BaseAPI.constructor
- Defined in encoding/manifests/hls/media/closedCaptions/ClosedCaptionsApi.ts:15
Parameters
- configuration: Configuration
Returns ClosedCaptionsApi

Properties

Protected restClient

restClient: RestClient

Methods

create

create(manifestId: string, closedCaptionsMediaInfo: ClosedCaptionsMediaInfo): Promise<ClosedCaptionsMediaInfo>

- Defined in encoding/manifests/hls/media/closedCaptions/ClosedCaptionsApi.ts:28
Parameters
- manifestId: string
- Optional closedCaptionsMediaInfo: ClosedCaptionsMediaInfo
Returns Promise<ClosedCaptionsMediaInfo>

delete

delete(manifestId: string, mediaId: string): Promise<BitmovinResponse>

- Defined in encoding/manifests/hls/media/closedCaptions/ClosedCaptionsApi.ts:44
Parameters
- manifestId: string
- mediaId: string
Returns Promise<BitmovinResponse>

get

get(manifestId: string, mediaId: string): Promise<ClosedCaptionsMediaInfo>

- Defined in encoding/manifests/hls/media/closedCaptions/ClosedCaptionsApi.ts:61
Parameters
- manifestId: string
- mediaId: string
Returns Promise<ClosedCaptionsMediaInfo>

list

list(manifestId: string, queryParameters: ClosedCaptionsMediaInfoListQueryParams | function): Promise<PaginationResponse<ClosedCaptionsMediaInfo>>

- Defined in encoding/manifests/hls/media/closedCaptions/ClosedCaptionsApi.ts:78
Parameters
- manifestId: string
- Optional queryParameters: ClosedCaptionsMediaInfoListQueryParams | function
Returns Promise<PaginationResponse<ClosedCaptionsMediaInfo>>

Generated using TypeDoc