Class SubtitleApi

Hierarchy

BaseAPI
- SubtitleApi

Index

Constructors

constructor

Properties

restClient

Methods

Constructors

constructor

new SubtitleApi(configuration: Configuration): SubtitleApi

Overrides BaseAPI.constructor
- Defined in encoding/manifests/dash/periods/adaptationsets/subtitle/SubtitleApi.ts:15
Parameters
- configuration: Configuration
Returns SubtitleApi

Properties

Protected restClient

restClient: RestClient

Methods

create

create(manifestId: string, periodId: string, subtitleAdaptationSet: SubtitleAdaptationSet): Promise<SubtitleAdaptationSet>

- Defined in encoding/manifests/dash/periods/adaptationsets/subtitle/SubtitleApi.ts:29
Parameters
- manifestId: string
- periodId: string
- Optional subtitleAdaptationSet: SubtitleAdaptationSet
Returns Promise<SubtitleAdaptationSet>

delete

delete(manifestId: string, periodId: string, adaptationsetId: string): Promise<BitmovinResponse>

- Defined in encoding/manifests/dash/periods/adaptationsets/subtitle/SubtitleApi.ts:47
Parameters
- manifestId: string
- periodId: string
- adaptationsetId: string
Returns Promise<BitmovinResponse>

get

get(manifestId: string, periodId: string, adaptationsetId: string): Promise<SubtitleAdaptationSet>

- Defined in encoding/manifests/dash/periods/adaptationsets/subtitle/SubtitleApi.ts:66
Parameters
- manifestId: string
- periodId: string
- adaptationsetId: string
Returns Promise<SubtitleAdaptationSet>

list

list(manifestId: string, periodId: string, queryParameters: SubtitleAdaptationSetListQueryParams | function): Promise<PaginationResponse<SubtitleAdaptationSet>>

- Defined in encoding/manifests/dash/periods/adaptationsets/subtitle/SubtitleApi.ts:85
Parameters
- manifestId: string
- periodId: string
- Optional queryParameters: SubtitleAdaptationSetListQueryParams | function
Returns Promise<PaginationResponse<SubtitleAdaptationSet>>

Generated using TypeDoc