### start Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/dashapi.html Starts the generation of a DASH manifest. ```APIDOC ## start ### Description Starts the generation of a DASH manifest. ### Parameters * **manifestId** (string) - The ID of the DASH manifest to start. * **startManifestRequest** (StartManifestRequest) - Optional. The request body for starting the manifest generation. ### Returns * Promise<[BitmovinResponse](bitmovinresponse.html)> - A promise that resolves with the response from the start operation. ``` -------------------------------- ### start Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/webapi.html Starts a custom player build process for a given build ID. ```APIDOC ## start ### Description Initiates the build process for a specified custom player build ID. ### Method POST ### Endpoint /start/{customBuildId} ### Parameters #### Path Parameters * **customBuildId** (string) - Required - The ID of the custom build to start. ### Returns * Promise<[BitmovinResponse](bitmovinresponse.html) angle - A promise that resolves with a response indicating the status of the start operation. ``` -------------------------------- ### start Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/liveapi.html Starts a live encoding. This initiates the live streaming process for a given encoding. ```APIDOC ## start ### Description Starts a live encoding. ### Method POST ### Endpoint /encoding/encodings/live/{encodingId}/start ### Parameters #### Path Parameters - **encodingId** (string) - Required - The ID of the encoding to start. #### Request Body - **startLiveEncodingRequest** (StartLiveEncodingRequest) - Optional - Configuration for starting the live encoding. ``` -------------------------------- ### HlsApi.start Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/hlsapi.html Starts an HLS manifest generation. ```APIDOC ## start ### Description Starts an HLS manifest generation. ### Signature ```typescript start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise ``` ### Parameters * **manifestId** (string) - The ID of the HLS manifest to start. * **startManifestRequest** (StartManifestRequest, optional) - The request body for starting the manifest generation. ### Returns * Promise<[BitmovinResponse](bitmovinresponse.html)> - A promise that resolves with the response from the API. ``` -------------------------------- ### Start Smooth Streaming Manifest Generation Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/smoothapi.html Starts the generation process for a specific Smooth Streaming manifest. ```APIDOC ## POST /encoding/manifests/smooth/{manifest_id}/start ### Description Starts the generation of a Smooth Streaming manifest. ### Method POST ### Endpoint /encoding/manifests/smooth/{manifest_id}/start ### Parameters #### Path Parameters - **manifest_id** (string) - Required - ID of the manifest to start #### Request Body - **startManifestRequest** (StartManifestRequest) - Optional - Request body for starting the manifest generation ``` -------------------------------- ### Get Encoding Start Request Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/encodingsapi.html Retrieves the start request details for a specific encoding. ```APIDOC ## getStartRequest ### Description Retrieves the start request details for a specific encoding. ### Method GET ### Endpoint /encoding/encodings/{encoding_id}/start ### Parameters #### Path Parameters - **encodingId** (string) - Required - The ID of the encoding. ``` -------------------------------- ### Get Encoding Start Request Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/encodingsapi.html Retrieves the start request details for a specific encoding by its ID. ```APIDOC ## GET /encodings/{encoding_id}/start-request ### Description Retrieves the start request details for a specific encoding. ### Method GET ### Endpoint /encodings/{encoding_id}/start-request ### Parameters #### Path Parameters - **encoding_id** (string) - Required - The ID of the encoding to get the start request for. ### Response #### Success Response (200 OK) - **encodingId** (string) - The ID of the encoding. - **inputs** (array) - Array of input configurations. - **outputs** (array) - Array of output configurations. #### Response Example ```json { "encodingId": "a1b2c3d4e5f67890", "inputs": [...], "outputs": [...] } ``` ``` -------------------------------- ### Get Live Encoding Start Request Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/liveapi.html Retrieves the start request configuration for a live encoding job. ```APIDOC ## getStartRequest ### Description Retrieves the start request configuration for a live encoding job. ### Method GET ### Endpoint /encoding/encodings/live/{encodingId}/start-request ### Parameters #### Path Parameters - **encodingId** (string) - Required - The ID of the live encoding job. ### Response #### Success Response (200) - **StartLiveEncodingRequest** - The response contains the start request configuration. ``` -------------------------------- ### startOffset Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/PackedAudioMuxing.html Specifies an offset in seconds for the MPEG-TS timestamps. For example, a 10-second offset would mean the first packet starts with a PTS of 900,000 if the MPEG-TS timescale is 90,000. ```APIDOC ## `Optional` startOffset ### Description Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale). ### Type `number` ### Memberof PackedAudioMuxing ``` -------------------------------- ### Vp8VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/Vp8VideoConfiguration.html Initializes a new instance of the Vp8VideoConfiguration class. It can optionally take a partial configuration object. ```APIDOC ## constructor * new Vp8VideoConfiguration(obj?: Partial) ### Parameters * `Optional` obj: Partial ### Returns Vp8VideoConfiguration Overrides VideoConfiguration.constructor * Defined in project/dist/bitmovin-openapi-clients/typescript/src/models/Vp8VideoConfiguration.ts:153 ``` -------------------------------- ### Vp9VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/Vp9VideoConfiguration.html Initializes a new instance of the Vp9VideoConfiguration class. It can optionally be initialized with a partial configuration object. ```APIDOC ## constructor * new Vp9VideoConfiguration(obj?: Partial): Vp9VideoConfiguration ### Description Initializes a new instance of the Vp9VideoConfiguration class. It can optionally be initialized with a partial configuration object. ### Parameters * `obj` (Partial) - Optional. An object containing properties to initialize the Vp9VideoConfiguration instance. ### Returns Vp9VideoConfiguration - A new instance of Vp9VideoConfiguration. ### Overrides Overrides [VideoConfiguration](VideoConfiguration.html).[constructor](VideoConfiguration.html#constructor) ### Source Defined in project/dist/bitmovin-openapi-clients/typescript/src/models/Vp9VideoConfiguration.ts:262 ``` -------------------------------- ### Install Bitmovin API SDK Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/README.md Install the Bitmovin API SDK using npm. This command installs version 1.272.2. ```bash npm install @bitmovin/api-sdk@1.272.2 ``` -------------------------------- ### H265VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/H265VideoConfiguration.html Initializes a new instance of the H265VideoConfiguration class. It can optionally take an object with partial configuration properties. ```APIDOC ## constructor ### Description Initializes a new instance of the H265VideoConfiguration class. ### Parameters * `obj` (Partial) - Optional. An object containing partial configuration properties to initialize the instance with. ### Returns H265VideoConfiguration ### Overrides [VideoConfiguration](VideoConfiguration.html#constructor) ``` -------------------------------- ### Start Encoding Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/encodingsapi.html Starts a specific encoding. ```APIDOC ## start ### Description Starts a specific encoding. ### Method POST ### Endpoint /encoding/encodings/{encoding_id}/start ### Parameters #### Path Parameters - **encodingId** (string) - Required - The ID of the encoding to start. #### Request Body - **startEncodingRequest** (StartEncodingRequest) - Optional - The request body containing start parameters. ``` -------------------------------- ### DolbyDigitalBitstreamInfo Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DolbyDigitalBitstreamInfo.html Initializes a new instance of the DolbyDigitalBitstreamInfo class. Optionally accepts an object with properties to set. ```APIDOC ## constructor ### Description Initializes a new instance of the DolbyDigitalBitstreamInfo class. ### Parameters * `obj` (Partial) - Optional. An object containing properties to initialize the instance with. ### Returns * DolbyDigitalBitstreamInfo - A new instance of the DolbyDigitalBitstreamInfo class. ``` -------------------------------- ### Start Encoding Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/encodingsapi.html Starts a specific encoding by its ID. ```APIDOC ## POST /encodings/{encoding_id}/start ### Description Starts a specific encoding. ### Method POST ### Endpoint /encodings/{encoding_id}/start ### Parameters #### Path Parameters - **encoding_id** (string) - Required - The ID of the encoding to start. ### Response #### Success Response (200 OK) - **status** (string) - The status of the encoding after the start request. #### Response Example ```json { "status": "STARTED" } ``` ``` -------------------------------- ### DolbyDigitalPlusBitstreamInfo Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DolbyDigitalPlusBitstreamInfo.html Initializes a new instance of the DolbyDigitalPlusBitstreamInfo class. Optionally accepts an object with initial property values. ```APIDOC ## constructor * new DolbyDigitalPlusBitstreamInfo(obj?: Partial) ### Parameters * `obj` (Optional) Partial<[DolbyDigitalPlusBitstreamInfo](DolbyDigitalPlusBitstreamInfo.html)> - An object containing initial property values. ### Returns * [DolbyDigitalPlusBitstreamInfo](DolbyDigitalPlusBitstreamInfo.html) - A new instance of the DolbyDigitalPlusBitstreamInfo class. ``` -------------------------------- ### Start Live Encoding Job Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/liveapi.html Starts a live encoding job. ```APIDOC ## start ### Description Starts a live encoding job. ### Method POST ### Endpoint /encoding/encodings/live/{encodingId}/start ### Parameters #### Path Parameters - **encodingId** (string) - Required - The ID of the live encoding job to start. ### Response #### Success Response (200) - **LiveEncoding** - The response contains the updated details of the live encoding job. ``` -------------------------------- ### constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/StartEncodingRequest.html Initializes a new instance of the StartEncodingRequest class. ```APIDOC ## constructor ### Description Initializes a new instance of the StartEncodingRequest class. ### Method constructor ### Parameters None ``` -------------------------------- ### start Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/AnalyticsMinQueryRequest.html Optional start date for the query timeframe, specified in UTC format. ```APIDOC ## start ### Description Optional start date for the query timeframe, specified in UTC format. ### Type `Date` ### Optional Yes ``` -------------------------------- ### AudioMediaInfo Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/AudioMediaInfo.html Initializes a new instance of the AudioMediaInfo class. It can optionally take an object with partial AudioMediaInfo properties to set initial values. ```APIDOC ## constructor * new AudioMediaInfo(obj?: Partial) ### Parameters * `obj` (Optional): Partial An object containing properties to initialize the AudioMediaInfo instance. ### Returns * AudioMediaInfo A new instance of the AudioMediaInfo class. ``` -------------------------------- ### Start Prewarmed Encoder Pool Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/prewarmedencoderpoolsapi.html Starts a specific Prewarmed Encoder Pool by its ID. ```APIDOC ## POST /encoding/infrastructure/prewarmed-encoder-pools/{pool_id}/start ### Description Starts a specific Prewarmed Encoder Pool by its ID. ### Method POST ### Endpoint /encoding/infrastructure/prewarmed-encoder-pools/{pool_id}/start ### Parameters #### Path Parameters - **poolId** (string) - Required - The ID of the Prewarmed Encoder Pool to start. ### Response #### Success Response (200) - **BitmovinResponse** (BitmovinResponse) - A response indicating the success of the start operation. ``` -------------------------------- ### DolbyDigitalPlusAudioConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/dolbydigitalplusaudioconfiguration.html Initializes a new instance of the DolbyDigitalPlusAudioConfiguration class. It can optionally take a partial configuration object. ```APIDOC ## constructor * new DolbyDigitalPlusAudioConfiguration(obj: Partial): DolbyDigitalPlusAudioConfiguration ### Description Initializes a new instance of the DolbyDigitalPlusAudioConfiguration class. ### Parameters * **obj** (Partial) - Optional. An object containing properties to initialize the configuration. ### Returns * **DolbyDigitalPlusAudioConfiguration** - A new instance of the DolbyDigitalPlusAudioConfiguration. ``` -------------------------------- ### H265V2VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/H265V2VideoConfiguration.html Initializes a new instance of the H265V2VideoConfiguration class. It can optionally take a partial configuration object. ```APIDOC ## constructor * new H265V2VideoConfiguration(obj?: Partial) ### Parameters * Optional obj: Partial ### Returns H265V2VideoConfiguration Overrides VideoConfiguration.constructor * Defined in project/dist/bitmovin-openapi-clients/typescript/src/models/H265V2VideoConfiguration.ts:60 ``` -------------------------------- ### H264VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/H264VideoConfiguration.html Initializes a new instance of the H264VideoConfiguration class. ```APIDOC ## constructor ### Description Initializes a new instance of the H264VideoConfiguration class. ### Parameters This constructor does not take any parameters. ### Returns - H264VideoConfiguration: An instance of the H264VideoConfiguration class. ``` -------------------------------- ### copyWithin Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/BitmovinResponseList.html Returns the this object after copying a section of the array identified by start and end to the same array starting at position target. ```APIDOC ## copyWithin ### Description Returns the this object after copying a section of the array identified by start and end to the same array starting at position target. ### Method ``` copyWithin(target: number, start: number, end?: number): this ``` ### Parameters * **target** (number) - If target is negative, it is treated as length+target where length is the length of the array. * **start** (number) - If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. * **end** (number, Optional) - If not specified, length of the this object is used as its default value. ### Returns * this: The this object after copying. ``` -------------------------------- ### DolbyVisionMuxingConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DolbyVisionMuxingConfiguration.html Initializes a new instance of the DolbyVisionMuxingConfiguration class. Optionally accepts an object with initial configuration values. ```APIDOC ## new DolbyVisionMuxingConfiguration(obj?: Partial) ### Description Initializes a new instance of the DolbyVisionMuxingConfiguration class. ### Parameters * `obj` (Partial) - Optional. An object containing initial configuration values for the DolbyVisionMuxingConfiguration. ### Returns * [DolbyVisionMuxingConfiguration] - A new instance of the DolbyVisionMuxingConfiguration class. ``` -------------------------------- ### get Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/progressivewebmapi.html Retrieves a specific Progressive WebM muxing. This allows you to get details about a particular Progressive WebM muxing associated with an encoding. ```APIDOC ## get ProgressiveWebmApi ### Description Retrieves a specific Progressive WebM muxing. ### Method GET ### Endpoint /encoding/encodings/{encoding_id}/muxings/progressive-webm/{muxing_id} ### Parameters #### Path Parameters - **encodingId** (string) - Required - The ID of the encoding. - **muxingId** (string) - Required - The ID of the muxing to retrieve. ### Response #### Success Response (200) - **id** (string) - The ID of the Progressive WebM muxing. - **type** (string) - The type of the muxing. - **filename** (string) - The filename of the muxing. ### Response Example ```json { "id": "muxing_id_123", "type": "progressive-webm", "filename": "output.webm" } ``` ``` -------------------------------- ### create Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/webapi.html Creates a new custom player build. Optionally accepts details for the build. ```APIDOC ## create ### Description Creates a new custom player build. This method can optionally accept details for the build. ### Method POST ### Endpoint /create ### Parameters #### Request Body * **customPlayerBuildDetails** ([CustomPlayerBuildDetails](customplayerbuilddetails.html)) - Optional. Details for the custom player build. ### Returns * Promise<[CustomPlayerBuildDetails](customplayerbuilddetails.html) angle - A promise that resolves with the details of the created custom player build. ``` -------------------------------- ### list Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/webapi.html Lists all available custom player builds. ```APIDOC ## list ### Description Retrieves a paginated list of all custom player builds. ### Method GET ### Endpoint /list ### Returns * Promise<[PaginationResponse](paginationresponse.html)<[CustomPlayerBuildDetails](customplayerbuilddetails.html) angle angle - A promise that resolves with a paginated response containing custom player build details. ``` -------------------------------- ### Get Webhook Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/errorapi.html Retrieves a specific error webhook. You can get a webhook by its ID or by specifying both encoding ID and webhook ID for encoding-specific webhooks. ```APIDOC ## GET /notifications/webhooks/encoding/encodings/{encodingId}/error/{webhookId} ### Description Retrieves a specific error webhook associated with a given encoding. ### Method GET ### Endpoint /notifications/webhooks/encoding/encodings/{encodingId}/error/{webhookId} ### Parameters #### Path Parameters - **encodingId** (string) - Required - The ID of the encoding. - **webhookId** (string) - Required - The ID of the webhook to retrieve. ``` -------------------------------- ### slice(start?, end?) Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/AnalyticsImpressionDetails.html Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. Inherited from Array.slice. ```APIDOC ## slice(start?, end?) ### Description Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array. ### Parameters #### Path Parameters * **start** (number) - Optional - The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0. * **end** (number) - Optional - The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array. ### Returns [AnalyticsImpressionSample] ### Inherited from Array.slice ``` -------------------------------- ### H265VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/h265videoconfiguration.html Initializes a new instance of the H265VideoConfiguration class. It can optionally take an object with partial H265VideoConfiguration properties to set initial values. ```APIDOC ## new H265VideoConfiguration(obj?: Partial) ### Description Initializes a new instance of the H265VideoConfiguration class. It can optionally take an object with partial H265VideoConfiguration properties to set initial values. ### Parameters * **obj** (Partial<[H265VideoConfiguration](h265videoconfiguration.html) angle) - Optional. An object containing properties to initialize the H265VideoConfiguration instance. ### Returns * [H265VideoConfiguration](h265videoconfiguration.html) - A new instance of H265VideoConfiguration. ``` -------------------------------- ### type Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/StreamsResponse.html Gets the type of the StreamsResponse. ```APIDOC ## type ### Description Gets the type of the StreamsResponse. ### Method getter ### Endpoint N/A (Property accessor) ### Parameters None ### Response - **type** (string) - The type of the StreamsResponse. ### Response Example ```json { "example": "STREAM" } ``` ``` -------------------------------- ### DolbyDigitalPlusAudioConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DolbyDigitalPlusAudioConfiguration.html Initializes a new instance of the DolbyDigitalPlusAudioConfiguration class. It can optionally take an object with properties to set the initial configuration. ```APIDOC ## constructor * new DolbyDigitalPlusAudioConfiguration(obj?: Partial) ### Parameters * `obj` (Optional): Partial An object containing properties to initialize the DolbyDigitalPlusAudioConfiguration. ### Returns * DolbyDigitalPlusAudioConfiguration A new instance of DolbyDigitalPlusAudioConfiguration. ``` -------------------------------- ### H262VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/H262VideoConfiguration.html Initializes a new instance of the H262VideoConfiguration class. It can optionally take a partial configuration object. ```APIDOC ## constructor ### Description Initializes a new instance of the H262VideoConfiguration class. It can optionally take a partial configuration object. ### Signature ```typescript new H262VideoConfiguration(obj?: Partial) ``` ### Parameters * `obj` (Partial): Optional. An object containing properties to initialize the H262VideoConfiguration instance. ### Returns H262VideoConfiguration ### Overrides [VideoConfiguration](VideoConfiguration.html#constructor).[constructor](VideoConfiguration.html#constructor) ### Defined in [project/dist/bitmovin-openapi-clients/typescript/src/models/H262VideoConfiguration.ts:88](https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/8e95298e7314062c01ce8dce515e6ccef6337b05/src/models/H262VideoConfiguration.ts#L88) ``` -------------------------------- ### title Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/StreamsResponse.html Gets the title of the StreamsResponse. ```APIDOC ## title ### Description Gets the title of the StreamsResponse. ### Method getter ### Endpoint N/A (Property accessor) ### Parameters None ### Response - **title** (string) - The title of the StreamsResponse. ### Response Example ```json { "example": "My Stream Title" } ``` ``` -------------------------------- ### description Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/StreamsResponse.html Gets the description of the StreamsResponse. ```APIDOC ## description ### Description Gets the description of the StreamsResponse. ### Method getter ### Endpoint N/A (Property accessor) ### Parameters None ### Response - **description** (string) - The description of the StreamsResponse. ### Response Example ```json { "example": "A sample description" } ``` ``` -------------------------------- ### H264VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/H264VideoConfiguration.html Initializes a new instance of the H264VideoConfiguration class. It can optionally take a partial configuration object. ```APIDOC ## new H264VideoConfiguration(obj?) ### Description Initializes a new instance of the H264VideoConfiguration class. ### Parameters * `obj` (Partial) - Optional. An object containing properties to initialize the H264VideoConfiguration. ### Returns H264VideoConfiguration - A new instance of H264VideoConfiguration. ### Overrides [VideoConfiguration](VideoConfiguration.html).[constructor](VideoConfiguration.html#constructor) ### Source Defined in project/dist/bitmovin-openapi-clients/typescript/src/models/H264VideoConfiguration.ts:357 ``` -------------------------------- ### manifestId Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/LiveDashManifest.html Gets the ID of the manifest. ```APIDOC ## manifestId ### Description Gets the ID of the manifest. ### Method Gets the manifest ID. ### Return type `string` ``` -------------------------------- ### DvbSubtitleConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/dvbsubtitleconfiguration.html Initializes a new instance of the DvbSubtitleConfiguration class. It can optionally take a partial object to pre-populate properties. ```APIDOC ## constructor ### Description Initializes a new instance of the DvbSubtitleConfiguration class. ### Signature ```typescript new DvbSubtitleConfiguration(obj?: Partial): DvbSubtitleConfiguration ``` ### Parameters * **obj** (Partial) - Optional. An object with properties to initialize the DvbSubtitleConfiguration instance. ### Returns DvbSubtitleConfiguration - A new instance of DvbSubtitleConfiguration. ``` -------------------------------- ### H264VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/h264videoconfiguration.html Initializes a new instance of the H264VideoConfiguration class. It can optionally take an object with properties to pre-configure the instance. ```APIDOC ## new H264VideoConfiguration(obj?: Partial) ### Description Constructs a new H264VideoConfiguration instance. The optional `obj` parameter allows for initializing the configuration with specific properties. ### Parameters #### Optional obj: Partial An object containing properties to initialize the H264VideoConfiguration. ### Returns H264VideoConfiguration A new instance of H264VideoConfiguration. ``` -------------------------------- ### id Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DashVttRepresentation.html Gets the identifier of the DashVttRepresentation. ```APIDOC ## id ### Description Gets the identifier of the DashVttRepresentation. ### Method getter ### Endpoint N/A ### Parameters None ### Request Example ```javascript representation.id ``` ### Response - **id** (string) - The identifier of the representation. ``` -------------------------------- ### AnalyticsGreaterThanFilter.value Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/AnalyticsGreaterThanFilter.html Gets the value of the filter. ```APIDOC ## value ### Description Gets the value of the filter. ### Method `value(): any` ``` -------------------------------- ### DolbyAtmosAudioConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DolbyAtmosAudioConfiguration.html Initializes a new instance of the DolbyAtmosAudioConfiguration class. It can optionally take an object with properties to pre-configure the instance. ```APIDOC ## constructor * new DolbyAtmosAudioConfiguration(obj?: Partial) ### Parameters * `obj` Optional: Partial<[DolbyAtmosAudioConfiguration](DolbyAtmosAudioConfiguration.html)> ### Returns [DolbyAtmosAudioConfiguration](DolbyAtmosAudioConfiguration.html) Overrides [AudioConfiguration](AudioConfiguration.html).constructor * Defined in project/dist/bitmovin-openapi-clients/typescript/src/models/DolbyAtmosAudioConfiguration.ts:32 ``` -------------------------------- ### AnalyticsGreaterThanFilter.operator Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/AnalyticsGreaterThanFilter.html Gets the operator of the filter. ```APIDOC ## operator ### Description Gets the operator of the filter. ### Method `operator(): string` ``` -------------------------------- ### MjpegVideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/MjpegVideoConfiguration.html Initializes a new instance of the MjpegVideoConfiguration class. It can optionally take an object with partial configuration properties. ```APIDOC ## constructor ### Signature * `new MjpegVideoConfiguration(obj?: Partial): MjpegVideoConfiguration` ### Parameters * `obj` (Partial<[MjpegVideoConfiguration]>): Optional. An object containing partial configuration properties to initialize the MjpegVideoConfiguration. ### Returns * [MjpegVideoConfiguration]: A new instance of MjpegVideoConfiguration. ### Overrides * Overrides [CodecConfiguration.constructor](CodecConfiguration.html#constructor) ### Defined in * `project/dist/bitmovin-openapi-clients/typescript/src/models/MjpegVideoConfiguration.ts:52` ``` -------------------------------- ### AnalyticsGreaterThanFilter.name Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/AnalyticsGreaterThanFilter.html Gets the name of the filter. ```APIDOC ## name ### Description Gets the name of the filter. ### Method `name(): string` ``` -------------------------------- ### PcmAudioConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/PcmAudioConfiguration.html Initializes a new instance of the PcmAudioConfiguration class. It can optionally take an object with partial PcmAudioConfiguration properties to set initial values. ```APIDOC ## constructor * new PcmAudioConfiguration(obj?: Partial) ### Parameters * `Optional` obj: Partial<[PcmAudioConfiguration](PcmAudioConfiguration.html)> ### Returns [PcmAudioConfiguration](PcmAudioConfiguration.html) Overrides [AudioConfiguration](AudioConfiguration.html).constructor * Defined in project/dist/bitmovin-openapi-clients/typescript/src/models/PcmAudioConfiguration.ts:41 ``` -------------------------------- ### List all configurations Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/configurationsapi.html Lists all available configurations, with options for filtering and pagination. ```APIDOC ## GET /configurations ### Description Lists all available configurations. Supports query parameters for filtering and pagination. ### Method GET ### Endpoint /configurations ### Parameters #### Query Parameters - **queryParameters** (object) - Optional - An object containing query parameters for filtering and pagination. Refer to [CodecConfigurationListQueryParams](../interfaces/codecconfigurationlistqueryparams.html) for available options. ### Response #### Success Response (200) - **PaginationResponse** (object) - A paginated response containing a list of codec configurations. ``` -------------------------------- ### RestClient.get Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/restclient.html Performs an HTTP GET request. ```APIDOC ## get ### Description Performs an HTTP GET request. ### Method GET ### Endpoint [URL provided in the `url` parameter] ### Parameters * **url** (string) - Required - The URL to send the GET request to. * **urlParameterMap** (undefined | object) - Optional - A map of URL parameters. * **queryStringParameters** (undefined | object) - Optional - A map of query string parameters. ### Returns * Promise - A promise that resolves with the response data of type T. ``` -------------------------------- ### BasicMediaInfo Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/BasicMediaInfo.html Initializes a new instance of the BasicMediaInfo class. It can optionally take an object with partial BasicMediaInfo properties to set initial values. ```APIDOC ## constructor * `new BasicMediaInfo(obj?: Partial): BasicMediaInfo` ### Parameters * `obj` (Partial) - Optional. An object containing properties to initialize the BasicMediaInfo instance. ### Returns * `BasicMediaInfo` - A new instance of the BasicMediaInfo class. ``` -------------------------------- ### Vp9Api List Method Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/vp9api.html Lists all VP9 video configurations. ```APIDOC ## GET /encoding/configurations/video/vp9 ### Description Lists all VP9 video configurations. ### Method GET ### Endpoint /encoding/configurations/video/vp9 ### Parameters #### Query Parameters - **queryParameters** (Vp9VideoConfigurationListQueryParams | function) - Optional - Query parameters for filtering the list. ``` -------------------------------- ### get Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/gcsapi.html Retrieves a GCS input by its ID. ```APIDOC ## get ### Description Retrieves a GCS input by its ID. ### Parameters * **inputId**: string ### Returns * Promise<[GcsInput](gcsinput.html)> ``` -------------------------------- ### id Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/StreamsResponse.html Gets the unique identifier of the StreamsResponse. ```APIDOC ## id ### Description Gets the unique identifier of the StreamsResponse. ### Method getter ### Endpoint N/A (Property accessor) ### Parameters None ### Response - **id** (string) - The unique identifier. ### Response Example ```json { "example": "a1b2c3d4-e5f6-7890-1234-567890abcdef" } ``` ``` -------------------------------- ### DolbyAtmosAudioConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/dolbyatmosaudioconfiguration.html Initializes a new instance of the DolbyAtmosAudioConfiguration class. It can optionally take an object with partial configuration properties. ```APIDOC ## new DolbyAtmosAudioConfiguration(obj?: Partial) ### Description Constructs a new DolbyAtmosAudioConfiguration instance. The constructor accepts an optional object containing properties to initialize the configuration. ### Parameters * **obj** (Partial<[DolbyAtmosAudioConfiguration](dolbyatmosaudioconfiguration.html) angle) - Optional. An object with properties to initialize the DolbyAtmosAudioConfiguration. ### Returns * [DolbyAtmosAudioConfiguration](dolbyatmosaudioconfiguration.html) - A new instance of DolbyAtmosAudioConfiguration. ``` -------------------------------- ### createdAt Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/StreamsResponse.html Gets the creation timestamp of the StreamsResponse. ```APIDOC ## createdAt ### Description Gets the creation timestamp of the StreamsResponse. ### Method getter ### Endpoint N/A (Property accessor) ### Parameters None ### Response - **createdAt** (Date) - The creation timestamp. ### Response Example ```json { "example": "new Date()" } ``` ``` -------------------------------- ### AudioMediaInfo Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/audiomediainfo.html Initializes a new instance of the AudioMediaInfo class. It can optionally take a partial AudioMediaInfo object for initialization and overrides the constructor from StandardMediaInfo. ```APIDOC ## constructor ### Description Initializes a new instance of the AudioMediaInfo class. ### Signature ```typescript new AudioMediaInfo(obj?: Partial): AudioMediaInfo ``` ### Parameters * **obj** (Partial) - Optional. An object with properties to initialize the AudioMediaInfo instance. ### Returns * **AudioMediaInfo** - A new instance of the AudioMediaInfo class. ``` -------------------------------- ### Vp9Api Create Method Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/vp9api.html Creates a VP9 video configuration. ```APIDOC ## POST /encoding/configurations/video/vp9 ### Description Creates a VP9 video configuration. ### Method POST ### Endpoint /encoding/configurations/video/vp9 ### Parameters #### Request Body - **vp9VideoConfiguration** (Vp9VideoConfiguration) - Optional - The VP9 video configuration object. ``` -------------------------------- ### type Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/SimpleEncodingLiveJobCdnOutput.html Gets the type of the CDN output. ```APIDOC ## type ### Description Gets the type of the CDN output. ### Type string ``` -------------------------------- ### name Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/Group.html Gets or sets the name of the group. ```APIDOC ## name ### Description Gets or sets the name of the group. ### Method getter/setter ### Endpoint N/A (Property accessor) ### Parameters - **name** (string) - Optional - The name to set for the group. ### Request Example ```javascript // Get name const groupName = group.name; // Set name group.name = 'New Group Name'; ``` ### Response - **name** (string) - The name of the group. ``` -------------------------------- ### VideoMediaInfo Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/VideoMediaInfo.html Initializes a new instance of the VideoMediaInfo class. It can optionally take an object with partial VideoMediaInfo properties to set initial values. ```APIDOC ## constructor * new VideoMediaInfo(obj?: Partial) ### Parameters * `Optional` obj: Partial<[VideoMediaInfo](VideoMediaInfo.html)> ### Returns [VideoMediaInfo](VideoMediaInfo.html) Overrides [StandardMediaInfo](StandardMediaInfo.html).[constructor](StandardMediaInfo.html#constructor) * Defined in project/dist/bitmovin-openapi-clients/typescript/src/models/VideoMediaInfo.ts:8 ``` -------------------------------- ### id Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/Group.html Gets the unique identifier of the group. ```APIDOC ## id ### Description Gets the unique identifier of the group. ### Method getter ### Endpoint N/A (Property accessor) ### Parameters None ### Request Example ```javascript const groupId = group.id; ``` ### Response - **id** (string) - The unique identifier of the group. ``` -------------------------------- ### create Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/dashapi.html Creates a new DASH manifest. ```APIDOC ## create ### Description Creates a new DASH manifest. ### Parameters * **dashManifest** (DashManifest) - Optional. The DASH manifest object to create. ### Returns * Promise<[DashManifest](dashmanifest.html)> - A promise that resolves with the created DASH manifest. ``` -------------------------------- ### description Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/Group.html Gets or sets the description of the group. ```APIDOC ## description ### Description Gets or sets the description of the group. ### Method getter/setter ### Endpoint N/A (Property accessor) ### Parameters - **description** (string) - Optional - The description to set for the group. ### Request Example ```javascript // Get description const desc = group.description; // Set description group.description = 'This is a sample group'; ``` ### Response - **description** (string) - The description of the group. ``` -------------------------------- ### DolbyAtmosPreprocessing Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DolbyAtmosPreprocessing.html Initializes a new instance of the DolbyAtmosPreprocessing class. It can optionally take an object with partial DolbyAtmosPreprocessing properties to set initial values. ```APIDOC ## constructor ### Description Initializes a new instance of the DolbyAtmosPreprocessing class. ### Method constructor ### Parameters * **obj** (Partial) - Optional - An object containing properties to initialize the DolbyAtmosPreprocessing instance. ### Returns * **DolbyAtmosPreprocessing** - A new instance of the DolbyAtmosPreprocessing class. ``` -------------------------------- ### createdAt Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/Group.html Gets the creation timestamp of the group. ```APIDOC ## createdAt ### Description Gets the creation timestamp of the group. ### Method getter ### Endpoint N/A (Property accessor) ### Parameters None ### Request Example ```javascript const creationTimestamp = group.createdAt; ``` ### Response - **createdAt** (Date) - The timestamp when the group was created. ``` -------------------------------- ### VideoConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/VideoConfiguration.html Initializes a new instance of the VideoConfiguration class. It can optionally take an object with partial configuration properties. ```APIDOC ## constructor new VideoConfiguration(obj?: Partial) ### Description Initializes a new instance of the VideoConfiguration class. It can optionally take an object with partial configuration properties. ### Parameters * **obj** (Partial) - Optional. An object containing properties to initialize the VideoConfiguration. ### Returns [VideoConfiguration] ### Overrides Overrides [CodecConfiguration.constructor](CodecConfiguration.html#constructor) ``` -------------------------------- ### Vp8Api.create Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/vp8api.html Creates a new VP8 video configuration. ```APIDOC ## create ### Description Creates a new VP8 video configuration. ### Parameters * **Optional vp8VideoConfiguration**: [Vp8VideoConfiguration](vp8videoconfiguration.html) ### Returns Promise<[Vp8VideoConfiguration](vp8videoconfiguration.html)> ``` -------------------------------- ### imscUrl Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DashImscRepresentation.html Gets the URL of the IMSC file. ```APIDOC ## imscUrl ### Description Gets the URL of the IMSC file. ### Returns * (string) - The URL of the IMSC file. ``` -------------------------------- ### value Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/AdAnalyticsEqualFilter.html Gets or sets the value to compare against. ```APIDOC ## value ### Description Gets or sets the value to compare against. ### Parameters - **value** (any) - The value to compare. ``` -------------------------------- ### DolbyDigitalAudioConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/DolbyDigitalAudioConfiguration.html Initializes a new instance of the DolbyDigitalAudioConfiguration class. It can optionally take an object with partial configuration properties. ```APIDOC ## constructor * new DolbyDigitalAudioConfiguration(obj?: Partial) ### Parameters * `Optional` obj: Partial ### Returns DolbyDigitalAudioConfiguration Overrides AudioConfiguration.constructor * Defined in project/dist/bitmovin-openapi-clients/typescript/src/models/DolbyDigitalAudioConfiguration.ts:63 ``` -------------------------------- ### Mp3AudioConfiguration Constructor Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/mp3audioconfiguration.html Initializes a new instance of the Mp3AudioConfiguration class. It can optionally take a partial configuration object. ```APIDOC ## constructor ### Description Initializes a new instance of the Mp3AudioConfiguration class. ### Signature ```typescript new Mp3AudioConfiguration(obj?: Partial): Mp3AudioConfiguration ``` ### Parameters * **obj** (Partial) - Optional. An object containing properties to initialize the Mp3AudioConfiguration instance. ### Returns Mp3AudioConfiguration - A new instance of Mp3AudioConfiguration. ``` -------------------------------- ### WatchFoldersApi.start Source: https://github.com/bitmovin/bitmovin-api-sdk-javascript/blob/main/docs/classes/watchfoldersapi.html Starts a specific watch folder by its ID. ```APIDOC ## start ### Description Starts a specific watch folder by its ID. ### Method POST ### Endpoint /encoding/watchfolders/{watchFolderId}:start ### Parameters #### Path Parameters - **watchFolderId** (string) - Required - The ID of the watch folder to start. ### Response #### Success Response (200) - **response** ([BitmovinResponse](bitmovinresponse.html)) - The response from the start operation. ### Request Example ```javascript api.watchfolders.start('your_watch_folder_id') ``` ### Response Example ```json { "id": "string", "status": "string", "data": {} } ``` ```