### Get Start Request

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/encodings/live/live_api.html

Retrieves the details required to start a live encoding.

```APIDOC
## GET /encoding/encodings/{encoding_id}/live/start

### Description
Retrieves the details required to start a live encoding.

### Method
GET

### Endpoint
/encoding/encodings/{encoding_id}/live/start

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - Id of the encoding.

### Response
#### Success Response (200)
- **service specific result** (StartLiveEncodingRequest) - Details for starting the live encoding.
```

--------------------------------

### Get Manifest Start Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/manifests/smooth/smooth_api.html

Retrieves the start details for a Smooth Streaming manifest.

```APIDOC
## GET /encoding/manifests/smooth/{manifest_id}/start

### Description
Retrieves the start details for a Smooth Streaming manifest.

### Method
GET

### Endpoint
/encoding/manifests/smooth/{manifest_id}/start

### Parameters
#### Path Parameters
- **manifest_id** (string) - Required - Id of the manifest.

### Response
#### Success Response (200)
- **id** (string) - Manifest ID
- **status** (string) - Manifest generation status
```

--------------------------------

### Get Manifest Start Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.manifests.hls.html

Retrieves the start details for a manifest.

```APIDOC
## GET /encoding/manifests/hls/{manifest_id}/start

### Description
Retrieves manifest start details.

### Method
GET

### Endpoint
/encoding/manifests/hls/{manifest_id}/start

### Parameters
#### Path Parameters
- **manifest_id** (string) - Required - Id of the HLS Manifest.
```

--------------------------------

### Get Manifest Start Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/manifests/dash/dash_api.html

Retrieves the start details for a DASH manifest.

```APIDOC
## GET /encoding/manifests/dash/{manifest_id}/start

### Description
Retrieves the start details for a DASH manifest.

### Method
GET

### Endpoint
/encoding/manifests/dash/{manifest_id}/start

### Parameters
#### Path Parameters
- **manifest_id** (string) - Required - Id of the manifest

### Response
#### Success Response (200)
- **StartManifestRequest** (StartManifestRequest) - Service specific result
```

--------------------------------

### Get Start Request Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/encodings/live/hd/hd_api.html

Retrieves the details required to start a live HD encoding. This is useful for understanding the parameters needed before initiating the encoding.

```APIDOC
## GET /encoding/encodings/{encoding_id}/live/hd/start

### Description
Live Encoding Start Details

### Method
GET

### Endpoint
/encoding/encodings/{encoding_id}/live/hd/start

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - Id of the encoding

### Response
#### Success Response (200)
- **StartLiveChannelEncodingRequest** (StartLiveChannelEncodingRequest) - Service specific result
```

--------------------------------

### Install Bitmovin Python API SDK using Setuptools (Python 2.7)

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/README.md

Install the SDK for Python 2.7 using the setup.py script.

```sh
python setup.py install
```

--------------------------------

### Install Bitmovin Python API SDK using Setuptools (Python 3.4+)

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/README.md

Install the SDK for Python 3.4+ using the setup.py script.

```sh
python3 setup.py install
```

--------------------------------

### Get Manifest Start Request Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.manifests.dash.html

Retrieves the start request details for a manifest.

```APIDOC
## GET /encoding/manifests/dash/{manifest_id}/start

### Description
Retrieves Manifest Start Details.

### Method
GET

### Endpoint
/encoding/manifests/dash/{manifest_id}/start

### Parameters
#### Path Parameters
- **manifest_id** (string) - Required - Id of the manifest

### Response
#### Success Response (200)
- **id** (string) - The ID of the start manifest request.
- **manifestId** (string) - The ID of the manifest associated with this start request.

### Response Example
```json
{
  "id": "start-request-123",
  "manifestId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```
```

--------------------------------

### LiveApi.start()

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.html

Starts a live encoding.

```APIDOC
## LiveApi.start()

### Description
Starts a live encoding.

### Method
POST

### Endpoint
/encoding/encodings/live/{encoding_id}/start

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - The ID of the live encoding to start.
```

--------------------------------

### Start Custom Web Player Build

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.player.custom_builds.web.html

Starts a custom web player build process for a given build ID.

```APIDOC
## POST /player/custom-builds/web/{custom_build_id}/start

### Description
Starts a custom web player build process.

### Method
POST

### Endpoint
/player/custom-builds/web/{custom_build_id}/start

### Parameters
#### Path Parameters
- **custom_build_id** (string) - Required - Id of the custom player build

### Response
#### Success Response (200)
- **BitmovinResponse** (BitmovinResponse) - Id of custom player build
```

--------------------------------

### Start Custom Web Player Build

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/player/custom_builds/web/web_api.html

Initiates a new custom web player build process. Provide the ID of the custom build configuration to start the build. This is typically used after defining a new custom player configuration.

```python
def start(self, custom_build_id, **kwargs):
    # type: (string_types, dict) -> BitmovinResponse
    """Start Custom Web Player Build

    :param custom_build_id: Id of the custom player build
    :type custom_build_id: string_types, required
    :return: Id of custom player build
    :rtype: BitmovinResponse
    """

    return self.api_client.post(
        '/player/custom-builds/web/{custom_build_id}/start',
        path_params={'custom_build_id': custom_build_id},
        type=BitmovinResponse,
        **kwargs
    )
```

--------------------------------

### Start Live Encoding

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/encodings/live/live_api.html

Starts a live encoding with specified startup options.

```APIDOC
## POST /encoding/encodings/{encoding_id}/live/start

### Description
Starts a live encoding with specified startup options.

### Method
POST

### Endpoint
/encoding/encodings/{encoding_id}/live/start

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - Id of the encoding.

#### Request Body
- **start_live_encoding_request** (StartLiveEncodingRequest) - Required - Live Encoding startup options.

### Response
#### Success Response (200)
- **Id of the encoding** (BitmovinResponse) - The ID of the started encoding.
```

--------------------------------

### Install Bitmovin Python API SDK (Python 2.7)

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/README.md

Use this command to install the SDK for Python 2.7 using pip.

```sh
pip install git+https://github.com/bitmovin/bitmovin-api-sdk-python.git
```

--------------------------------

### Install Bitmovin Python API SDK (Python 3.4+)

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/README.md

Use this command to install the SDK for Python 3.4+ using pip3.

```sh
pip3 install git+https://github.com/bitmovin/bitmovin-api-sdk-python.git
```

--------------------------------

### Start Watch Folder - Python

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/watch_folders/watch_folders_api.html

Starts a specific watch folder identified by its ID. Use this to enable a watch folder to start processing files.

```python
def start(self, watch_folder_id, **kwargs):
    """Start Watch Folder

    :param watch_folder_id: Id of the Watch Folder
    :type watch_folder_id: string_types, required
    :return: Id of the Watch Folder
    :rtype: BitmovinResponse
    """

    return self.api_client.post(
        '/encoding/watch-folders/{watch_folder_id}/start',
        path_params={'watch_folder_id': watch_folder_id},
        type=BitmovinResponse,
        **kwargs
    )
```

--------------------------------

### Initialize QcApi

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/encodings/streams/qc/qc_api.html

Initializes the QcApi with necessary credentials and optional parameters. It also sets up the PsnrApi as a sub-component.

```python
from __future__ import absolute_import

from bitmovin_api_sdk.common import BaseApi, BitmovinApiLoggerBase
from bitmovin_api_sdk.common.poscheck import poscheck_except
from bitmovin_api_sdk.encoding.encodings.streams.qc.psnr.psnr_api import PsnrApi


class QcApi(BaseApi):
    @poscheck_except(2)
    def __init__(self, api_key, tenant_org_id=None, base_url=None, logger=None):
        # type: (str, str, str, BitmovinApiLoggerBase) -> None

        super(QcApi, self).__init__(
            api_key=api_key,
            tenant_org_id=tenant_org_id,
            base_url=base_url,
            logger=logger
        )

        self.psnr = PsnrApi(
            api_key=api_key,
            tenant_org_id=tenant_org_id,
            base_url=base_url,
            logger=logger
        )
```

--------------------------------

### Get Encoding Start Request

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.html

Retrieves the start request details for a specific encoding.

```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 - Id of the encoding.

### Response
#### Success Response (200)
- **encodingId** (string) - The ID of the encoding.
- **statisticOwner** (string) - The owner of the statistics.
- **branching** (boolean) - Whether branching is enabled.
- **priority** (integer) - The priority of the encoding job.
- **customData** (object) - Custom data associated with the start request.

#### Response Example
{
  "encodingId": "string",
  "statisticOwner": "string",
  "branching": true,
  "priority": 0,
  "customData": {}
}
```

--------------------------------

### LiveApi.start

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.live.html

Starts a live encoding with the specified ID and startup options.

```APIDOC
## POST /encodings/live/{encoding_id}/start

### Description
Starts a live encoding.

### Method
POST

### Endpoint
/encodings/live/{encoding_id}/start

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - Id of the encoding.
#### Request Body
- **start_live_encoding_request** (StartLiveEncodingRequest) - Required - Live Encoding startup options.

### Response
#### Success Response (200)
- **id** (string) - Id of the encoding.
```

--------------------------------

### EncodingsApi.get_start_request

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/genindex.html

Retrieves the start request configuration for an encoding.

```APIDOC
## GET /encoding/encodings/{encoding_id}/start-request

### Description
Retrieves the start request configuration for a specific encoding.

### Method
GET

### Endpoint
/encoding/encodings/{encoding_id}/start-request

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - The ID of the encoding.
```

--------------------------------

### Get Live Start Request

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/history_encoding.html

Retrieves the live encoding start request from the HistoryEncoding object.

```APIDOC
## Get Live Start Request

### Description
Retrieves the live encoding start request of this HistoryEncoding.

### Method
```python
get_live_start_reqeust()
```

### Returns
- **StartLiveEncodingRequest**: The live encoding start request of this HistoryEncoding.
```

--------------------------------

### Get Vod Start Request

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/history_encoding.html

Retrieves the VOD encoding start request from the HistoryEncoding object.

```APIDOC
## Get Vod Start Request

### Description
Retrieves the VOD encoding start request of this HistoryEncoding.

### Method
```python
get_vod_start_reqeust()
```

### Returns
- **StartEncodingRequest**: The VOD encoding start request of this HistoryEncoding.
```

--------------------------------

### WebApi.start

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/genindex.html

Starts a custom web player build. This operation is part of the Player module.

```APIDOC
## start

### Description
Starts a custom web player build.

### Method
POST

### Endpoint
/player/custom-builds/web/{web_player_build_id}/start

### Parameters
#### Path Parameters
- **web_player_build_id** (string) - Required - The ID of the web player build to start
```

--------------------------------

### Get Encoding Start Request Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/encodings/encodings_api.html

Retrieves the details of the start request for a specific encoding by its ID.

```APIDOC
## GET /encoding/encodings/{encoding_id}/start

### Description
Retrieves the details of the start request for a specific encoding by its ID.

### Method
GET

### Endpoint
/encoding/encodings/{encoding_id}/start

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - The ID of the encoding.

### Response
#### Success Response (200)
- **StartEncodingRequest** - The details of the encoding start request.

### Response Example
```json
{
  "encodingId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "startTime": "2023-10-27T10:05:00Z"
}
```
```

--------------------------------

### LiveApi.get_start_request()

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.html

Retrieves the start request for a live encoding.

```APIDOC
## LiveApi.get_start_request()

### Description
Retrieves the start request for a live encoding.

### Method
GET

### Endpoint
/encoding/encodings/live/{encoding_id}/start

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - The ID of the live encoding for which to retrieve the start request.
```

--------------------------------

### LiveApi Initialization

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/live/live_api.html

Initializes the LiveApi with necessary credentials and configuration.

```APIDOC
## LiveApi

### Description

The LiveApi class provides access to live encoding features within the Bitmovin API.

### Methods

- `__init__(self, api_key, tenant_org_id=None, base_url=None, logger=None)`: Initializes the LiveApi instance.

### Attributes

- `encodings`: An instance of `EncodingsApi` for managing live encodings.
- `dns_mappings`: An instance of `DnsMappingsApi` for managing DNS mappings.
- `stream_keys`: An instance of `StreamKeysApi` for managing stream keys.
- `standby_pools`: An instance of `StandbyPoolsApi` for managing standby pools.
```

--------------------------------

### Get Manifest Start Request Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.manifests.smooth.html

Retrieves the start request details for a specific manifest by its ID.

```APIDOC
## GET /encoding/manifests/smooth/{manifest_id}/start-request

### Description
Retrieves the start request details for a manifest.

### Method
GET

### Endpoint
/encoding/manifests/smooth/{manifest_id}/start-request

### Parameters
#### Path Parameters
- **manifest_id** (string) - Required - Id of the manifest.

### Response
#### Success Response (200)
- **StartManifestRequest** - Service specific result.

### Response Example
{
  "example": "StartManifestRequest object"
}
```

--------------------------------

### Get HLS Manifest Start Request Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/manifests/hls/hls_api.html

Retrieves the details of the start request for a specific HLS manifest.

```APIDOC
## GET /encoding/manifests/hls/{manifest_id}/start

### Description
Retrieves the details of the start request for a specific HLS manifest.

### Method
GET

### Endpoint
/encoding/manifests/hls/{manifest_id}/start

### Parameters
#### Path Parameters
- **manifest_id** (string) - Required - ID of the manifest

#### Response
#### Success Response (200)
- **StartManifestRequest** - Service specific result
```

--------------------------------

### Vp9VideoConfiguration Methods

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/vp9_video_configuration.html

Provides documentation for the `to_str`, `__repr__`, `__eq__`, and `__ne__` methods of the Vp9VideoConfiguration class.

```APIDOC
## Vp9VideoConfiguration Methods

### `to_str()`

Returns the string representation of the model.

### `__repr__()`

For `print` and `pprint`.

### `__eq__(self, other)`

Returns true if both objects are equal.

### `__ne__(self, other)`

Returns true if both objects are not equal.
```

--------------------------------

### ConfigApi Initialization

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/streams/config/config_api.html

Initializes the ConfigApi with necessary credentials and configuration options. It also sets up the DomainRestrictionApi.

```APIDOC
## ConfigApi

### Description
Initializes the ConfigApi with necessary credentials and configuration options. It also sets up the DomainRestrictionApi.

### Method
__init__

### Parameters
*   **api_key** (str) - Required - The API key for authentication.
*   **tenant_org_id** (str) - Optional - The tenant organization ID.
*   **base_url** (str) - Optional - The base URL for the API.
*   **logger** (BitmovinApiLoggerBase) - Optional - A logger instance.

### Attributes
*   **domain_restriction** (DomainRestrictionApi) - An instance of DomainRestrictionApi for managing domain restrictions.
```

--------------------------------

### Get Encoding Started At

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/encoding.html

Retrieves the timestamp when the encoding was started. The timestamp is returned in UTC, expressed in ISO 8601 format.

```python
return self._started_at
```

--------------------------------

### AnalyticsQueryTimeframe

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.models.html

Represents a timeframe for analytics queries, with methods to get start and end times, convert to dictionary, and get string representation.

```APIDOC
## AnalyticsQueryTimeframe

### Description
Represents a timeframe for analytics queries. It allows retrieval of start and end times in UTC format.

### Methods
- **start()**: Gets the start of the timeframe.
- **end()**: Gets the end of the timeframe.
- **to_dict()**: Returns the model properties as a dictionary.
- **to_str()**: Returns the string representation of the model.

### Properties
- **start** (datetime) - Start of timeframe which is queried in UTC format.
- **end** (datetime) - End of timeframe which is queried in UTC format.
- **attribute_map** (dict) - Mapping of model attributes to their API representations.
- **openapi_types** (dict) - Mapping of model attributes to their OpenAPI types.
```

--------------------------------

### Get Encoding Start Request Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/encodings/encodings_api.html

Fetch the details of the start request for a specific encoding job. This can be useful for understanding the parameters used when initiating an encoding.

```python
return self.api_client.get(
    '/encoding/encodings/{encoding_id}/start',
    path_params={'encoding_id': encoding_id},
    type=StartEncodingRequest,
    **kwargs
)
```

--------------------------------

### Tweaks Model Initialization and Properties

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/tweaks.html

Demonstrates how to initialize the Tweaks model and access its properties, specifically `audio_video_sync_mode`.

```APIDOC
## Tweaks Model

### Description

Represents specific adjustments or tweaks that can be applied to an encoding job. Currently, it supports configuration for audio-video synchronization.

### Initialization

```python
from bitmovin_api_sdk.models.tweaks import Tweaks
from bitmovin_api_sdk.models.audio_video_sync_mode import AudioVideoSyncMode

tweaks = Tweaks(audio_video_sync_mode=AudioVideoSyncMode.AUTO)
```

### Properties

*   **audio_video_sync_mode** (`AudioVideoSyncMode`):
    Different modes for syncing the start and end of audio input streams with the video inputs. This feature does not work with Dolby Digital (Plus) or Dolby Atmos.

    *Getter*: `tweaks.audio_video_sync_mode`
    *Setter*: `tweaks.audio_video_sync_mode = AudioVideoSyncMode.STRICT`

### Methods

*   **to_dict()**: Returns the model properties as a dictionary.
*   **to_str()**: Returns the string representation of the model.
```

--------------------------------

### Get HD Live Encoding Start Request

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.live.hd.html

Retrieves the details required to start an HD live encoding. This is useful for understanding the parameters needed before initiating the encoding.

```APIDOC
## get_start_request

### Description
Retrieves the details required to start an HD live encoding.

### Method Signature
`get_start_request(_encoding_id_, _**kwargs_)`

### Parameters
#### Path Parameters
*   **encoding_id** (string) - Required - The ID of the encoding.

### Returns
*   **StartLiveChannelEncodingRequest** - Service specific result containing details for starting the live encoding.
```

--------------------------------

### Vp8VideoConfiguration Constructor

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/vp8_video_configuration.html

Initializes a new instance of the Vp8VideoConfiguration class with various VP8 encoding parameters.

```APIDOC
## Vp8VideoConfiguration(crf=None, lag_in_frames=None, max_intra_rate=None, qp_min=None, qp_max=None, rate_undershoot_pct=None, rate_overshoot_pct=None, cpu_used=None, noise_sensitivity=None, sharpness=None, min_gop=None, max_gop=None, min_keyframe_interval=None, max_keyframe_interval=None, quality=None, static_thresh=None, arnr_max_frames=None, arnr_strength=None, arnr_type=None)

### Description
Initializes a new instance of the Vp8VideoConfiguration class.

### Parameters
* **crf** (int) - Optional - Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.
* **lag_in_frames** (int) - Optional - Enables lag-aware rate control. If set, the encoder will look ahead this many frames to optimize rate control.
* **max_intra_rate** (int) - Optional - Maximum I-frame bitrate. If set, the encoder will not exceed this bitrate for I-frames.
* **qp_min** (int) - Optional - Minimum QP (Quantization Parameter). Controls the minimum quality level.
* **qp_max** (int) - Optional - Maximum QP (Quantization Parameter). Controls the maximum quality level.
* **rate_undershoot_pct** (int) - Optional - Percentage of undershoot allowed for the rate control.
* **rate_overshoot_pct** (int) - Optional - Percentage of overshoot allowed for the rate control.
* **cpu_used** (int) - Optional - CPU usage level. Higher values result in better compression but longer encoding times.
* **noise_sensitivity** (Vp8NoiseSensitivity) - Optional - Controls the sensitivity to noise in the input video.
* **sharpness** (int) - Optional - Controls the sharpness of the output video.
* **min_gop** (int) - Optional - Minimum Group of Pictures (GOP) length.
* **max_gop** (int) - Optional - Maximum Group of Pictures (GOP) length.
* **min_keyframe_interval** (float) - Optional - Minimum interval between keyframes in seconds.
* **max_keyframe_interval** (float) - Optional - Maximum interval between keyframes in seconds.
* **quality** (Vp8Quality) - Optional - The quality setting for VP8 encoding.
* **static_thresh** (int) - Optional - Threshold for static regions. Helps in optimizing compression for static areas.
* **arnr_max_frames** (int) - Optional - Maximum number of frames for ARNR (Adaptive Reference Noise Reduction).
* **arnr_strength** (int) - Optional - Strength of ARNR filtering.
* **arnr_type** (Vp8ArnrType) - Optional - Type of ARNR filtering to apply.
```

--------------------------------

### Vp9VideoConfiguration Constructor

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/vp9_video_configuration.html

Initializes a new instance of the Vp9VideoConfiguration class. This constructor accepts numerous parameters to configure various aspects of VP9 video encoding.

```APIDOC
## Vp9VideoConfiguration(id_=None, name=None, description=None, created_at=None, modified_at=None, custom_data=None, width=None, height=None, bitrate=None, rate=None, pixel_format=None, color_config=None, sample_aspect_ratio_numerator=None, sample_aspect_ratio_denominator=None, display_aspect_ratio=None, encoding_mode=None, preset_configuration=None, dynamic_range_format=None, crf=None, lag_in_frames=None, error_resiliency_enabled=None, tile_columns=None, tile_rows=None, frame_parallel=None, max_intra_rate=None, qp_min=None, qp_max=None, rate_undershoot_pct=None, rate_overshoot_pct=None, client_buffer_size=None, client_initial_buffer_size=None, bias_pct=None, noise_sensitivity=None, cpu_used=None, automatic_alt_ref_frames_enabled=None, target_level=None, row_multi_threading_enabled=None, sharpness=None, min_gop=None, max_gop=None, min_keyframe_interval=None, max_keyframe_interval=None, quality=None, lossless=None, static_thresh=None, aq_mode=None, arnr_max_frames=None, arnr_strength=None, arnr_type=None, auto_level_setup=None)

### Description
Initializes a new instance of the Vp9VideoConfiguration class.

### Parameters
* **id_** (string) - Optional
* **name** (string) - Optional
* **description** (string) - Optional
* **created_at** (datetime) - Optional
* **modified_at** (datetime) - Optional
* **custom_data** (dict) - Optional
* **width** (int) - Optional
* **height** (int) - Optional
* **bitrate** (int) - Optional
* **rate** (float) - Optional
* **pixel_format** (PixelFormat) - Optional
* **color_config** (ColorConfig) - Optional
* **sample_aspect_ratio_numerator** (int) - Optional
* **sample_aspect_ratio_denominator** (int) - Optional
* **display_aspect_ratio** (DisplayAspectRatio) - Optional
* **encoding_mode** (EncodingMode) - Optional
* **preset_configuration** (PresetConfiguration) - Optional
* **dynamic_range_format** (Vp9DynamicRangeFormat) - Optional
* **crf** (int) - Optional
* **lag_in_frames** (int) - Optional
* **error_resiliency_enabled** (bool) - Optional
* **tile_columns** (int) - Optional
* **tile_rows** (int) - Optional
* **frame_parallel** (bool) - Optional
* **max_intra_rate** (int) - Optional
* **qp_min** (int) - Optional
* **qp_max** (int) - Optional
* **rate_undershoot_pct** (int) - Optional
* **rate_overshoot_pct** (int) - Optional
* **client_buffer_size** (int) - Optional
* **client_initial_buffer_size** (int) - Optional
* **bias_pct** (int) - Optional
* **noise_sensitivity** (int) - Optional
* **cpu_used** (int) - Optional
* **automatic_alt_ref_frames_enabled** (bool) - Optional
* **target_level** (int) - Optional
* **row_multi_threading_enabled** (bool) - Optional
* **sharpness** (int) - Optional
* **min_gop** (int) - Optional
* **max_gop** (int) - Optional
* **min_keyframe_interval** (int) - Optional
* **max_keyframe_interval** (int) - Optional
* **quality** (Vp9Quality) - Optional
* **lossless** (bool) - Optional
* **static_thresh** (int) - Optional
* **aq_mode** (Vp9AqMode) - Optional
* **arnr_max_frames** (int) - Optional
* **arnr_strength** (int) - Optional
* **arnr_type** (Vp9ArnrType) - Optional
* **auto_level_setup** (AutoLevelSetup) - Optional
```

--------------------------------

### Encoding Started At Property

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/encoding.html

Details on how to get and set the 'started_at' property of the Encoding model.

```APIDOC
## Encoding Started At

### Get Started At

```python
get_started_at() -> datetime
```

Gets the started_at of this Encoding.

**Timestamp when the encoding was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ**

:return: The started_at of this Encoding.
:rtype: datetime

### Set Started At

```python
set_started_at(started_at: datetime) -> None
```

Sets the started_at of this Encoding.

**Timestamp when the encoding was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ**

:param started_at: The started_at of this Encoding.
:type: datetime

**Raises:**
    TypeError: If the provided started_at is not an instance of datetime.
```

--------------------------------

### QcApi Initialization

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/encodings/streams/qc/qc_api.html

Initializes the QcApi with necessary authentication and configuration details. It also sets up access to sub-APIs like PsnrApi.

```APIDOC
## QcApi

### Description

Initializes the QcApi with necessary authentication and configuration details. It also sets up access to sub-APIs like PsnrApi.

### Method Signature

`QcApi(api_key: str, tenant_org_id: Optional[str] = None, base_url: Optional[str] = None, logger: Optional[BitmovinApiLoggerBase] = None)`

### Parameters

- **api_key** (str) - Required - Your Bitmovin API key.
- **tenant_org_id** (str) - Optional - The ID of the tenant organization.
- **base_url** (str) - Optional - The base URL for the Bitmovin API.
- **logger** (BitmovinApiLoggerBase) - Optional - A logger instance for API communication.

### Attributes

- **psnr** (PsnrApi) - An instance of PsnrApi for accessing PSNR-related QC metrics.
```

--------------------------------

### Av1VideoConfiguration Properties

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/av1_video_configuration.html

This section details the properties of the Av1VideoConfiguration model, including how to get and set preset configurations and auto level setup.

```APIDOC
## Av1VideoConfiguration

### Properties

#### `preset_configuration`

*   **Description**: Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.
*   **Type**: `Av1PresetConfiguration`

#### `auto_level_setup`

*   **Description**: Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.
*   **Type**: `AutoLevelSetup`

### Methods

#### `to_dict()`

*   **Description**: Returns the model properties as a dict.
*   **Returns**: `dict`

#### `to_str()`

*   **Description**: Returns the string representation of the model.
*   **Returns**: `str`

#### `__repr__()`

*   **Description**: For `print` and `pprint`.
*   **Returns**: `str`

#### `__eq__(other)`

*   **Description**: Returns true if both objects are equal.
*   **Parameters**:
    *   `other` (object) - The object to compare with.
*   **Returns**: `bool`

#### `__ne__(other)`

*   **Description**: Returns true if both objects are not equal.
*   **Parameters**:
    *   `other` (object) - The object to compare with.
*   **Returns**: `bool`
```

--------------------------------

### AnalyticsIncident Properties

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/analytics_incident.html

This section describes the properties of the AnalyticsIncident model, including 'start', 'end', and 'is_recovered'. It also shows how to get and set these properties.

```APIDOC
## AnalyticsIncident Properties

### Description
Provides access to the start, end, and recovery status of an analytics incident.

### Properties
- **start** (string) - The start date of the incident.
- **end** (string) - The end date of the incident.
- **is_recovered** (bool) - The recovery state of the incident.

### Getters and Setters
- `get_start()`: Returns the start date of the incident.
- `set_start(start: string)`: Sets the start date of the incident.
- `get_end()`: Returns the end date of the incident.
- `set_end(end: string)`: Sets the end date of the incident.
- `get_is_recovered()`: Returns the recovery state of the incident.
- `set_is_recovered(is_recovered: bool)`: Sets the recovery state of the incident.
```

--------------------------------

### Get Corrupt Packets Audio

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/live_encoding_heartbeat_ingest.html

Retrieves the total number of corrupt audio packets since the live encoding started. This property is of type int.

```python
    @property
def corrupt_packets_audio(self):
    # type: () -> int
    """Gets the corrupt_packets_audio of this LiveEncodingHeartbeatIngest.

    Total number of corrupt audio packets since the live encoding started. 

    :return: The corrupt_packets_audio of this LiveEncodingHeartbeatIngest.
    :rtype: int
    """
    return self._corrupt_packets_audio
```

--------------------------------

### Tenant Model Initialization and Properties

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/tenant.html

Demonstrates how to initialize a Tenant object and access its properties, including the email address.

```APIDOC
## Tenant Model

Represents a tenant in the Bitmovin platform.

### Initialization

```python
Tenant(id_=None, name=None, description=None, created_at=None, modified_at=None, custom_data=None, e_mail=None)
```

### Properties

*   **id** (string) - The unique identifier of the tenant.
*   **name** (string) - The name of the tenant.
*   **description** (string) - A description of the tenant.
*   **created_at** (datetime) - The timestamp when the tenant was created.
*   **modified_at** (datetime) - The timestamp when the tenant was last modified.
*   **custom_data** (dict) - Custom data associated with the tenant.
*   **e_mail** (string) - The email address of the tenant. (required)

### Methods

*   **to_dict()**: Returns the model properties as a dictionary.
```

--------------------------------

### Get Corrupt Packets Video

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/live_encoding_heartbeat_ingest.html

Retrieves the total number of corrupt video packets since the live encoding started. This property is of type int.

```python
    @property
def corrupt_packets_video(self):
    # type: () -> int
    """Gets the corrupt_packets_video of this LiveEncodingHeartbeatIngest.

    Total number of corrupt video packets since the live encoding started. 

    :return: The corrupt_packets_video of this LiveEncodingHeartbeatIngest.
    :rtype: int
    """
    return self._corrupt_packets_video
```

--------------------------------

### Initialize Bitmovin API

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/README.md

Initialize the BitmovinApi client with your API key. Replace '<YOUR_API_KEY>' with your actual Bitmovin API key.

```python
from bitmovin_api_sdk import BitmovinApi


bitmovinApi = BitmovinApi(api_key='<YOUR_API_KEY>')
```

--------------------------------

### BitmovinApi Initialization

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/bitmovin_api.html

Initializes the BitmovinApi client with API key and optional tenant organization ID, base URL, and logger.

```APIDOC
## BitmovinApi

### Description
Initializes the BitmovinApi client with API key and optional tenant organization ID, base URL, and logger.

### Method
```python
BitmovinApi(api_key: str, tenant_org_id: str = None, base_url: str = None, logger: BitmovinApiLoggerBase = None)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```python
from bitmovin_api_sdk import BitmovinApi

api = BitmovinApi(api_key='YOUR_API_KEY')
```

### Response
None

### Sub-APIs
This class provides access to the following sub-APIs:

- **account**: For account-related operations.
- **agents**: For agent-related operations.
- **ai_scene_analysis**: For AI scene analysis operations.
- **analytics**: For analytics-related operations.
- **encoding**: For encoding-related operations.
- **general**: For general API operations.
- **notifications**: For notification-related operations.
- **player**: For player-related operations.
- **streams**: For stream-related operations.
```

--------------------------------

### Get Dropped Packets Audio

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/live_encoding_heartbeat_ingest.html

Retrieves the total number of dropped audio packets since the live encoding started. This property is of type int.

```python
    @property
def dropped_packets_audio(self):
    # type: () -> int
    """Gets the dropped_packets_audio of this LiveEncodingHeartbeatIngest.

    Total number of dropped audio packets since the live encoding started. 

    :return: The dropped_packets_audio of this LiveEncodingHeartbeatIngest.
    :rtype: int
    """
    return self._dropped_packets_audio
```

--------------------------------

### PlayerApi Initialization

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/player/player_api.html

Initializes the PlayerApi with necessary credentials and configuration.

```APIDOC
## PlayerApi

### Description

The PlayerApi class provides access to player-related functionalities, including managing player channels, licenses, and custom builds.

### Methods

- `__init__(self, api_key, tenant_org_id=None, base_url=None, logger=None)`: Initializes the PlayerApi.
  - `api_key` (str): Your Bitmovin API key.
  - `tenant_org_id` (str, optional): Your tenant organization ID.
  - `base_url` (str, optional): The base URL for the Bitmovin API.
  - `logger` (BitmovinApiLoggerBase, optional): A logger instance.

### Sub-modules

- `channels`: Provides access to player channel management.
- `licenses`: Provides access to player license management.
- `custom_builds`: Provides access to custom player build management.
```

--------------------------------

### Get Dropped Packets Video

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/live_encoding_heartbeat_ingest.html

Retrieves the total number of dropped video packets since the live encoding started. This property is of type int.

```python
    @property
def dropped_packets_video(self):
    # type: () -> int
    """Gets the dropped_packets_video of this LiveEncodingHeartbeatIngest.

    Total number of dropped video packets since the live encoding started. 

    :return: The dropped_packets_video of this LiveEncodingHeartbeatIngest.
    :rtype: int
    """
    return self._dropped_packets_video
```

--------------------------------

### Get Statistics per Label by Date Range

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/encoding/statistics/labels/labels_api.html

Retrieves encoding statistics per label within a specified date range. Requires start and end dates.

```APIDOC
## Get statistics per label within specific dates

### Description
Get statistics per label within specific dates

### Method
GET

### Endpoint
/encoding/statistics/labels/{from}/{to}

### Parameters
#### Path Parameters
- **from** (date) - Required - Start date. Format: yyyy-MM-dd
- **to** (date) - Required - End date. Format: yyyy-MM-dd
#### Query Parameters
- **query_params** (StatisticsPerLabelListByDateRangeQueryParams) - Optional - Query parameters for filtering the results.

### Response
#### Success Response (200)
- **StatisticsPerLabel** (StatisticsPerLabel) - List of encoding statistics for this label.
```

--------------------------------

### OutputsApi Initialization

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/analytics/outputs/outputs_api.html

Initializes the OutputsApi with necessary authentication and configuration details.

```APIDOC
## OutputsApi

### Description

Provides access to all the analytics output configurations.

### Methods

- **__init__(self, api_key, tenant_org_id=None, base_url=None, logger=None)**
  Initializes the OutputsApi.

  #### Parameters
  - **api_key** (str) - Required - Your Bitmovin API key.
  - **tenant_org_id** (str) - Optional - Your tenant organization ID.
  - **base_url** (str) - Optional - The base URL for the Bitmovin API.
  - **logger** (BitmovinApiLoggerBase) - Optional - A logger instance.

### Sub-APIs

- **azure**: Access to Azure output configurations.
- **s3_role_based**: Access to S3 Role-Based output configurations.
- **gcs_service_account**: Access to GCS Service Account output configurations.
```

--------------------------------

### Get CENC DRM Details

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.muxings.webm.drm.cenc.html

Retrieves the details of a specific CENC DRM configuration associated with a WebM muxing. This allows you to inspect the configuration of a particular DRM setup.

```APIDOC
## GET /encodings/{encoding_id}/muxings/webm/{muxing_id}/drm/cenc/{drm_id}

### Description
Gets CENC DRM details of a WebM muxing.

### Method
GET

### Endpoint
`/encodings/{encoding_id}/muxings/webm/{muxing_id}/drm/cenc/{drm_id}`

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - Id of the encoding.
- **muxing_id** (string) - Required - Id of the WebM muxing.
- **drm_id** (string) - Required - Id of the cenc drm.

### Response
#### Success Response (200)
- **CencDrm** (CencDrm) - The CENC DRM configuration.
```

--------------------------------

### Get FairPlay DRM Custom Data

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.muxings.progressive_ts.drm.fairplay.customdata.html

Retrieves the custom data for a FairPlay DRM configuration of a Progressive TS muxing. This allows you to fetch any custom metadata associated with the DRM setup.

```APIDOC
## GET /encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}/drm/fairplay/{drm_id}/customdata

### Description
Retrieves the custom data for a FairPlay DRM configuration of a Progressive TS muxing.

### Method
GET

### Endpoint
/encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}/drm/fairplay/{drm_id}/customdata

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - Id of the encoding.
- **muxing_id** (string) - Required - Id of the Progressive TS muxing.
- **drm_id** (string) - Required - Id of the FairPlay DRM configuration.

### Response
#### Success Response (200)
- **customData** (CustomData) - S3 output custom data
```

--------------------------------

### Get Marlin DRM Custom Data

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.muxings.mp4.drm.marlin.customdata.html

Retrieves the custom data for a Marlin DRM configuration applied to an MP4 muxing. This allows you to fetch any additional metadata associated with the DRM setup.

```APIDOC
## GET /encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}/drm/marlin/{drm_id}/customData

### Description
Retrieves the custom data for a Marlin DRM configuration.

### Method
GET

### Endpoint
/encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}/drm/marlin/{drm_id}/customData

### Parameters
#### Path Parameters
- **encoding_id** (string) - Required - Id of the encoding.
- **muxing_id** (string) - Required - Id of the mp4 muxing.
- **drm_id** (string) - Required - Id of the Marlin DRM configuration.

### Response
#### Success Response (200)
- **customData** (CustomData) - Marlin DRM custom data.
```

--------------------------------

### CustomPlayerBuildDownload Methods

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/custom_player_build_download.html

Provides documentation for the `to_str`, `__repr__`, `__eq__`, and `__ne__` methods of the CustomPlayerBuildDownload model.

```APIDOC
## CustomPlayerBuildDownload Methods

### `to_str()`

Returns the string representation of the model.

### `__repr__()`

For `print` and `pprint` operations.

### `__eq__(self, other)`

Returns true if both objects are equal.

### `__ne__(self, other)`

Returns true if both objects are not equal.
```

--------------------------------

### StartManifestRequest Methods

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/start_manifest_request.html

Provides methods for converting the StartManifestRequest object to a dictionary, a formatted string, and for comparing equality with other objects.

```APIDOC
## StartManifestRequest

### Description
Represents a request to start a manifest generation process.

### Methods

#### `to_dict()`
Converts the model to a dictionary representation.

#### `to_str()`
Returns the string representation of the model, formatted for readability.

#### `__repr__()`
Provides a developer-friendly representation of the object, typically used for debugging.

#### `__eq__(other)`
Compares the current object with another object for equality. Returns `True` if both objects are instances of `StartManifestRequest` and have identical attributes, `False` otherwise.

#### `__ne__(other)`
Compares the current object with another object for inequality. Returns `True` if the objects are not equal, `False` otherwise.
```

--------------------------------

### Selected Encoding Mode

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/encoding.html

Gets the encoding mode that was actually used after the encoding has been started. This is especially helpful when the `encodingMode` was not explicitly set or was set to 'STANDARD', as it reveals the specific mode that was ultimately applied.

```APIDOC
## Selected Encoding Mode

### Description
Gets the encoding mode that was actually used after the encoding has been started. This is especially helpful when the `encodingMode` was not explicitly set or was set to 'STANDARD', as it reveals the specific mode that was ultimately applied.

### Method
GETTER/SETTER

### Property
`selected_encoding_mode`

### Type
EncodingMode

### Example (Getter)
```python
encoding_mode = encoding_instance.selected_encoding_mode
```

### Example (Setter)
```python
from bitmovin_api_sdk.models import EncodingMode

encoding_instance.selected_encoding_mode = EncodingMode.PERḲ_SEGMENT
```
```

--------------------------------

### DolbyAtmosPreprocessing Model Initialization

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/_modules/bitmovin_api_sdk/models/dolby_atmos_preprocessing.html

Initializes the DolbyAtmosPreprocessing model. Optionally accepts a DolbyAtmosDynamicRangeCompression object.

```python
dolby_atmos_preprocessing = DolbyAtmosPreprocessing(dynamic_range_compression=dolby_atmos_dynamic_range_compression)
```

--------------------------------

### Get PrimeTime DRM Custom Data

Source: https://github.com/bitmovin/bitmovin-api-sdk-python/blob/main/docs/__modules/bitmovin_api_sdk.encoding.encodings.muxings.fmp4.drm.primetime.customdata.html

Retrieves the custom data associated with a specific PrimeTime DRM configuration for an fMP4 muxing. This allows you to fetch any custom metadata linked to the DRM setup.

```APIDOC
## Get PrimeTime DRM Custom Data

### Description
Retrieves the custom data for a specific PrimeTime DRM configuration of an fMP4 muxing.

### Method
`get(encoding_id: str, muxing_id: str, drm_id: str, **kwargs)`

### Parameters
#### Path Parameters
*   **encoding_id** (string) - Required - The ID of the encoding.
*   **muxing_id** (string) - Required - The ID of the fMP4 muxing.
*   **drm_id** (string) - Required - The ID of the PrimeTime DRM configuration.

### Response
#### Success Response (200)
- **CustomData** - The PrimeTime DRM custom data object.

### Response Example
```json
{
  "key": "value"
}
```
```