bitmovin_api_sdk.models package
Submodules
bitmovin_api_sdk.models.aac_audio_configuration module
- class bitmovin_api_sdk.models.aac_audio_configuration.AacAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this AacAudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this AacAudioConfiguration.
- Return type
- property cutoff_frequency
Gets the cutoff_frequency of this AacAudioConfiguration.
The highest frequency that will pass the audio encoder. This value is optional.
- Returns
The cutoff_frequency of this AacAudioConfiguration.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.aac_channel_layout module
- class bitmovin_api_sdk.models.aac_channel_layout.AacChannelLayout(value)[source]
Bases:
EnumAn enumeration.
- CL_4_0 = '4.0'
- CL_5_0_BACK = '5.0_BACK'
- CL_5_1_BACK = '5.1_BACK'
- CL_7_1 = '7.1'
- CL_7_1_WIDE_BACK = '7.1_WIDE_BACK'
- CL_STEREO = 'STEREO'
- CL_SURROUND = 'SURROUND'
- MONO = 'MONO'
- NONE = 'NONE'
bitmovin_api_sdk.models.abstract_condition module
bitmovin_api_sdk.models.abstract_conjunction module
- class bitmovin_api_sdk.models.abstract_conjunction.AbstractConjunction(**kwargs)[source]
Bases:
AbstractCondition- property attribute_map
- property conditions
Gets the conditions of this AbstractConjunction.
Array to perform the AND/OR evaluation on
- Returns
The conditions of this AbstractConjunction.
- Return type
list[AbstractCondition]
- property openapi_types
bitmovin_api_sdk.models.ac3_audio_configuration module
- class bitmovin_api_sdk.models.ac3_audio_configuration.Ac3AudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this Ac3AudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this Ac3AudioConfiguration.
- Return type
- property cutoff_frequency
Gets the cutoff_frequency of this Ac3AudioConfiguration.
The highest frequency that will pass the audio encoder. This value is optional.
- Returns
The cutoff_frequency of this Ac3AudioConfiguration.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.ac3_channel_layout module
- class bitmovin_api_sdk.models.ac3_channel_layout.Ac3ChannelLayout(value)[source]
Bases:
EnumAn enumeration.
- CL_2_1 = '2.1'
- CL_2_2 = '2.2'
- CL_3_1 = '3.1'
- CL_4_0 = '4.0'
- CL_4_1 = '4.1'
- CL_5_0 = '5.0'
- CL_5_0_BACK = '5.0_BACK'
- CL_5_1 = '5.1'
- CL_5_1_BACK = '5.1_BACK'
- CL_QUAD = 'QUAD'
- CL_STEREO = 'STEREO'
- CL_SURROUND = 'SURROUND'
- MONO = 'MONO'
- NONE = 'NONE'
bitmovin_api_sdk.models.accessibility module
- class bitmovin_api_sdk.models.accessibility.Accessibility(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property scheme_id_uri
Gets the scheme_id_uri of this Accessibility.
The scheme id to use. Please refer to the DASH standard. (required)
- Returns
The scheme_id_uri of this Accessibility.
- Return type
string_types
- property value
Gets the value of this Accessibility.
Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology) (required)
- Returns
The value of this Accessibility.
- Return type
string_types
bitmovin_api_sdk.models.account_api_key module
- class bitmovin_api_sdk.models.account_api_key.AccountApiKey(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property openapi_types
- property value
Gets the value of this AccountApiKey.
Key value for authentication with the Bitmovin API (required)
- Returns
The value of this AccountApiKey.
- Return type
string_types
bitmovin_api_sdk.models.account_information module
- class bitmovin_api_sdk.models.account_information.AccountInformation(**kwargs)[source]
Bases:
BitmovinResource- property api_keys
Gets the api_keys of this AccountInformation.
ApiKeys associated with the account (required)
- Returns
The api_keys of this AccountInformation.
- Return type
list[AccountApiKey]
- property attribute_map
- property company
Gets the company of this AccountInformation.
Company name of the tenant.
- Returns
The company of this AccountInformation.
- Return type
string_types
- property email
Gets the email of this AccountInformation.
Email address of the account. (required)
- Returns
The email of this AccountInformation.
- Return type
string_types
- property first_name
Gets the first_name of this AccountInformation.
First name of the tenant.
- Returns
The first_name of this AccountInformation.
- Return type
string_types
- property intercom_id_verification
Gets the intercom_id_verification of this AccountInformation.
- Returns
The intercom_id_verification of this AccountInformation.
- Return type
string_types
- property last_name
Gets the last_name of this AccountInformation.
Last name of the tenant.
- Returns
The last_name of this AccountInformation.
- Return type
string_types
- property marketplace
Gets the marketplace of this AccountInformation.
- Returns
The marketplace of this AccountInformation.
- Return type
- property mfa_enabled
Gets the mfa_enabled of this AccountInformation.
- Returns
The mfa_enabled of this AccountInformation.
- Return type
bool
- property openapi_types
- property phone
Gets the phone of this AccountInformation.
Phone number of the tenant.
- Returns
The phone of this AccountInformation.
- Return type
string_types
- property verified
Gets the verified of this AccountInformation.
- Returns
The verified of this AccountInformation.
- Return type
bool
bitmovin_api_sdk.models.acl module
- class bitmovin_api_sdk.models.acl.Acl(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property openapi_types
- property permissions
Gets the permissions of this Acl.
Permissions to assign. (required)
- Returns
The permissions of this Acl.
- Return type
list[Permission]
- property resource
Gets the resource of this Acl.
Resource to define the permission for. (required)
- Returns
The resource of this Acl.
- Return type
string_types
bitmovin_api_sdk.models.acl_entry module
- class bitmovin_api_sdk.models.acl_entry.AclEntry(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property permission
Gets the permission of this AclEntry.
- Returns
The permission of this AclEntry.
- Return type
- property scope
Gets the scope of this AclEntry.
Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all
- Returns
The scope of this AclEntry.
- Return type
string_types
bitmovin_api_sdk.models.acl_permission module
bitmovin_api_sdk.models.ad_analytics_abstract_filter module
- class bitmovin_api_sdk.models.ad_analytics_abstract_filter.AdAnalyticsAbstractFilter(**kwargs)[source]
Bases:
object- property attribute_map
- discriminator_value_class_map = {'CONTAINS': 'AdAnalyticsContainsFilter', 'EQ': 'AdAnalyticsEqualFilter', 'GT': 'AdAnalyticsGreaterThanFilter', 'GTE': 'AdAnalyticsGreaterThanOrEqualFilter', 'IN': 'AdAnalyticsInFilter', 'LT': 'AdAnalyticsLessThanFilter', 'LTE': 'AdAnalyticsLessThanOrEqualFilter', 'NE': 'AdAnalyticsNotEqualFilter', 'NOTCONTAINS': 'AdAnalyticsNotContainsFilter'}
- property name
Gets the name of this AdAnalyticsAbstractFilter.
- Returns
The name of this AdAnalyticsAbstractFilter.
- Return type
- property openapi_types
bitmovin_api_sdk.models.ad_analytics_attribute module
- class bitmovin_api_sdk.models.ad_analytics_attribute.AdAnalyticsAttribute(value)[source]
Bases:
EnumAn enumeration.
- ADVERTISER_NAME = 'ADVERTISER_NAME'
- AD_CLICKTHROUGH_URL = 'AD_CLICKTHROUGH_URL'
- AD_DESCRIPTION = 'AD_DESCRIPTION'
- AD_DURATION = 'AD_DURATION'
- AD_FALLBACK_INDEX = 'AD_FALLBACK_INDEX'
- AD_ID = 'AD_ID'
- AD_ID_PLAYER = 'AD_ID_PLAYER'
- AD_IMPRESSION_ID = 'AD_IMPRESSION_ID'
- AD_IS_PERSISTENT = 'AD_IS_PERSISTENT'
- AD_MODULE = 'AD_MODULE'
- AD_OFFSET = 'AD_OFFSET'
- AD_PLAYBACK_HEIGHT = 'AD_PLAYBACK_HEIGHT'
- AD_PLAYBACK_WIDTH = 'AD_PLAYBACK_WIDTH'
- AD_POD_POSITION = 'AD_POD_POSITION'
- AD_POSITION = 'AD_POSITION'
- AD_PRELOAD_OFFSET = 'AD_PRELOAD_OFFSET'
- AD_REPLACE_CONTENT_DURATION = 'AD_REPLACE_CONTENT_DURATION'
- AD_SCHEDULE_TIME = 'AD_SCHEDULE_TIME'
- AD_SKIPPABLE = 'AD_SKIPPABLE'
- AD_SKIP_AFTER = 'AD_SKIP_AFTER'
- AD_STARTUP_TIME = 'AD_STARTUP_TIME'
- AD_SYSTEM = 'AD_SYSTEM'
- AD_TAG_PATH = 'AD_TAG_PATH'
- AD_TAG_SERVER = 'AD_TAG_SERVER'
- AD_TAG_TYPE = 'AD_TAG_TYPE'
- AD_TAG_URL = 'AD_TAG_URL'
- AD_TITLE = 'AD_TITLE'
- AD_WRAPPER_ADS_COUNT = 'AD_WRAPPER_ADS_COUNT'
- ANALYTICS_VERSION = 'ANALYTICS_VERSION'
- API_FRAMEWORK = 'API_FRAMEWORK'
- AUDIO_BITRATE = 'AUDIO_BITRATE'
- AUDIO_CODEC = 'AUDIO_CODEC'
- AUTOPLAY = 'AUTOPLAY'
- BROWSER = 'BROWSER'
- BROWSER_VERSION_MAJOR = 'BROWSER_VERSION_MAJOR'
- CDN_PROVIDER = 'CDN_PROVIDER'
- CITY = 'CITY'
- CLICKED = 'CLICKED'
- CLICK_PERCENTAGE = 'CLICK_PERCENTAGE'
- CLICK_POSITION = 'CLICK_POSITION'
- CLIENT_TIME = 'CLIENT_TIME'
- CLOSED = 'CLOSED'
- CLOSE_PERCENTAGE = 'CLOSE_PERCENTAGE'
- CLOSE_POSITION = 'CLOSE_POSITION'
- COMPLETED = 'COMPLETED'
- COUNTRY = 'COUNTRY'
- CREATIVE_AD_ID = 'CREATIVE_AD_ID'
- CREATIVE_ID = 'CREATIVE_ID'
- CUSTOM_DATA_1 = 'CUSTOM_DATA_1'
- CUSTOM_DATA_10 = 'CUSTOM_DATA_10'
- CUSTOM_DATA_11 = 'CUSTOM_DATA_11'
- CUSTOM_DATA_12 = 'CUSTOM_DATA_12'
- CUSTOM_DATA_13 = 'CUSTOM_DATA_13'
- CUSTOM_DATA_14 = 'CUSTOM_DATA_14'
- CUSTOM_DATA_15 = 'CUSTOM_DATA_15'
- CUSTOM_DATA_16 = 'CUSTOM_DATA_16'
- CUSTOM_DATA_17 = 'CUSTOM_DATA_17'
- CUSTOM_DATA_18 = 'CUSTOM_DATA_18'
- CUSTOM_DATA_19 = 'CUSTOM_DATA_19'
- CUSTOM_DATA_2 = 'CUSTOM_DATA_2'
- CUSTOM_DATA_20 = 'CUSTOM_DATA_20'
- CUSTOM_DATA_21 = 'CUSTOM_DATA_21'
- CUSTOM_DATA_22 = 'CUSTOM_DATA_22'
- CUSTOM_DATA_23 = 'CUSTOM_DATA_23'
- CUSTOM_DATA_24 = 'CUSTOM_DATA_24'
- CUSTOM_DATA_25 = 'CUSTOM_DATA_25'
- CUSTOM_DATA_26 = 'CUSTOM_DATA_26'
- CUSTOM_DATA_27 = 'CUSTOM_DATA_27'
- CUSTOM_DATA_28 = 'CUSTOM_DATA_28'
- CUSTOM_DATA_29 = 'CUSTOM_DATA_29'
- CUSTOM_DATA_3 = 'CUSTOM_DATA_3'
- CUSTOM_DATA_30 = 'CUSTOM_DATA_30'
- CUSTOM_DATA_4 = 'CUSTOM_DATA_4'
- CUSTOM_DATA_5 = 'CUSTOM_DATA_5'
- CUSTOM_DATA_6 = 'CUSTOM_DATA_6'
- CUSTOM_DATA_7 = 'CUSTOM_DATA_7'
- CUSTOM_DATA_8 = 'CUSTOM_DATA_8'
- CUSTOM_DATA_9 = 'CUSTOM_DATA_9'
- CUSTOM_USER_ID = 'CUSTOM_USER_ID'
- DAY = 'DAY'
- DEAL_ID = 'DEAL_ID'
- DEVICE_CLASS = 'DEVICE_CLASS'
- DEVICE_TYPE = 'DEVICE_TYPE'
- DOMAIN = 'DOMAIN'
- ERROR_CODE = 'ERROR_CODE'
- ERROR_PERCENTAGE = 'ERROR_PERCENTAGE'
- ERROR_POSITION = 'ERROR_POSITION'
- EXIT_POSITION = 'EXIT_POSITION'
- EXPERIMENT_NAME = 'EXPERIMENT_NAME'
- HOUR = 'HOUR'
- IP_ADDRESS = 'IP_ADDRESS'
- ISP = 'ISP'
- IS_LINEAR = 'IS_LINEAR'
- LANGUAGE = 'LANGUAGE'
- LICENSE_KEY = 'LICENSE_KEY'
- MANIFEST_DOWNLOAD_TIME = 'MANIFEST_DOWNLOAD_TIME'
- MEDIA_PATH = 'MEDIA_PATH'
- MEDIA_SERVER = 'MEDIA_SERVER'
- MEDIA_URL = 'MEDIA_URL'
- MIDPOINT = 'MIDPOINT'
- MINUTE = 'MINUTE'
- MIN_SUGGESTED_DURATION = 'MIN_SUGGESTED_DURATION'
- MONTH = 'MONTH'
- OPERATINGSYSTEM = 'OPERATINGSYSTEM'
- OPERATINGSYSTEM_VERSION_MAJOR = 'OPERATINGSYSTEM_VERSION_MAJOR'
- PAGE_LOAD_TIME = 'PAGE_LOAD_TIME'
- PAGE_LOAD_TYPE = 'PAGE_LOAD_TYPE'
- PATH = 'PATH'
- PERCENTAGE_IN_VIEWPORT = 'PERCENTAGE_IN_VIEWPORT'
- PLATFORM = 'PLATFORM'
- PLAYER = 'PLAYER'
- PLAYER_KEY = 'PLAYER_KEY'
- PLAYER_STARTUPTIME = 'PLAYER_STARTUPTIME'
- PLAYER_TECH = 'PLAYER_TECH'
- PLAYER_VERSION = 'PLAYER_VERSION'
- PLAY_PERCENTAGE = 'PLAY_PERCENTAGE'
- QUARTILE_1 = 'QUARTILE_1'
- QUARTILE_3 = 'QUARTILE_3'
- REGION = 'REGION'
- SCALE_FACTOR = 'SCALE_FACTOR'
- SCREEN_HEIGHT = 'SCREEN_HEIGHT'
- SCREEN_ORIENTATION = 'SCREEN_ORIENTATION'
- SCREEN_WIDTH = 'SCREEN_WIDTH'
- SIZE = 'SIZE'
- SKIPPED = 'SKIPPED'
- SKIP_PERCENTAGE = 'SKIP_PERCENTAGE'
- SKIP_POSITION = 'SKIP_POSITION'
- STARTED = 'STARTED'
- STREAM_FORMAT = 'STREAM_FORMAT'
- SURVEY_URL = 'SURVEY_URL'
- TIME = 'TIME'
- TIME_IN_VIEWPORT = 'TIME_IN_VIEWPORT'
- TIME_PLAYED = 'TIME_PLAYED'
- UNIVERSAL_AD_ID_REGISTRY = 'UNIVERSAL_AD_ID_REGISTRY'
- UNIVERSAL_AD_ID_VALUE = 'UNIVERSAL_AD_ID_VALUE'
- USER_ID = 'USER_ID'
- VIDEO_BITRATE = 'VIDEO_BITRATE'
- VIDEO_CODEC = 'VIDEO_CODEC'
- VIDEO_ID = 'VIDEO_ID'
- VIDEO_IMPRESSION_ID = 'VIDEO_IMPRESSION_ID'
- VIDEO_TITLE = 'VIDEO_TITLE'
- VIDEO_WINDOW_HEIGHT = 'VIDEO_WINDOW_HEIGHT'
- VIDEO_WINDOW_WIDTH = 'VIDEO_WINDOW_WIDTH'
bitmovin_api_sdk.models.ad_analytics_avg_query_request module
bitmovin_api_sdk.models.ad_analytics_contains_filter module
- class bitmovin_api_sdk.models.ad_analytics_contains_filter.AdAnalyticsContainsFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsContainsFilter.
- Returns
The value of this AdAnalyticsContainsFilter.
- Return type
object
bitmovin_api_sdk.models.ad_analytics_count_query_request module
bitmovin_api_sdk.models.ad_analytics_equal_filter module
- class bitmovin_api_sdk.models.ad_analytics_equal_filter.AdAnalyticsEqualFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsEqualFilter.
- Returns
The value of this AdAnalyticsEqualFilter.
- Return type
object
bitmovin_api_sdk.models.ad_analytics_greater_than_filter module
- class bitmovin_api_sdk.models.ad_analytics_greater_than_filter.AdAnalyticsGreaterThanFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsGreaterThanFilter.
- Returns
The value of this AdAnalyticsGreaterThanFilter.
- Return type
object
bitmovin_api_sdk.models.ad_analytics_greater_than_or_equal_filter module
- class bitmovin_api_sdk.models.ad_analytics_greater_than_or_equal_filter.AdAnalyticsGreaterThanOrEqualFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsGreaterThanOrEqualFilter.
- Returns
The value of this AdAnalyticsGreaterThanOrEqualFilter.
- Return type
object
bitmovin_api_sdk.models.ad_analytics_in_filter module
- class bitmovin_api_sdk.models.ad_analytics_in_filter.AdAnalyticsInFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsInFilter.
- Returns
The value of this AdAnalyticsInFilter.
- Return type
list[object]
bitmovin_api_sdk.models.ad_analytics_less_than_filter module
- class bitmovin_api_sdk.models.ad_analytics_less_than_filter.AdAnalyticsLessThanFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsLessThanFilter.
- Returns
The value of this AdAnalyticsLessThanFilter.
- Return type
object
bitmovin_api_sdk.models.ad_analytics_less_than_or_equal_filter module
- class bitmovin_api_sdk.models.ad_analytics_less_than_or_equal_filter.AdAnalyticsLessThanOrEqualFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsLessThanOrEqualFilter.
- Returns
The value of this AdAnalyticsLessThanOrEqualFilter.
- Return type
object
bitmovin_api_sdk.models.ad_analytics_max_query_request module
bitmovin_api_sdk.models.ad_analytics_median_query_request module
bitmovin_api_sdk.models.ad_analytics_min_query_request module
bitmovin_api_sdk.models.ad_analytics_not_contains_filter module
- class bitmovin_api_sdk.models.ad_analytics_not_contains_filter.AdAnalyticsNotContainsFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsNotContainsFilter.
- Returns
The value of this AdAnalyticsNotContainsFilter.
- Return type
object
bitmovin_api_sdk.models.ad_analytics_not_equal_filter module
- class bitmovin_api_sdk.models.ad_analytics_not_equal_filter.AdAnalyticsNotEqualFilter(**kwargs)[source]
Bases:
AdAnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AdAnalyticsNotEqualFilter.
- Returns
The value of this AdAnalyticsNotEqualFilter.
- Return type
object
bitmovin_api_sdk.models.ad_analytics_order_by_entry module
- class bitmovin_api_sdk.models.ad_analytics_order_by_entry.AdAnalyticsOrderByEntry(**kwargs)[source]
Bases:
object- property attribute_map
- property name
Gets the name of this AdAnalyticsOrderByEntry.
- Returns
The name of this AdAnalyticsOrderByEntry.
- Return type
- property openapi_types
- property order
Gets the order of this AdAnalyticsOrderByEntry.
- Returns
The order of this AdAnalyticsOrderByEntry.
- Return type
bitmovin_api_sdk.models.ad_analytics_percentile_query_request module
- class bitmovin_api_sdk.models.ad_analytics_percentile_query_request.AdAnalyticsPercentileQueryRequest(**kwargs)[source]
Bases:
AdAnalyticsQueryRequest- property attribute_map
- property openapi_types
- property percentile
Gets the percentile of this AdAnalyticsPercentileQueryRequest.
The percentage (0-99) used for percentile queries. (required)
- Returns
The percentile of this AdAnalyticsPercentileQueryRequest.
- Return type
int
bitmovin_api_sdk.models.ad_analytics_query_request module
- class bitmovin_api_sdk.models.ad_analytics_query_request.AdAnalyticsQueryRequest(**kwargs)[source]
Bases:
AnalyticsQueryTimeframe- property attribute_map
- property dimension
Gets the dimension of this AdAnalyticsQueryRequest.
- Returns
The dimension of this AdAnalyticsQueryRequest.
- Return type
- property filters
Gets the filters of this AdAnalyticsQueryRequest.
Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]
- Returns
The filters of this AdAnalyticsQueryRequest.
- Return type
- property group_by
Gets the group_by of this AdAnalyticsQueryRequest.
- Returns
The group_by of this AdAnalyticsQueryRequest.
- Return type
list[AdAnalyticsAttribute]
- property interval
Gets the interval of this AdAnalyticsQueryRequest.
- Returns
The interval of this AdAnalyticsQueryRequest.
- Return type
- property license_key
Gets the license_key of this AdAnalyticsQueryRequest.
Analytics license key (required)
- Returns
The license_key of this AdAnalyticsQueryRequest.
- Return type
string_types
- property limit
Gets the limit of this AdAnalyticsQueryRequest.
Maximum number of rows returned (max. 200)
- Returns
The limit of this AdAnalyticsQueryRequest.
- Return type
int
- property offset
Gets the offset of this AdAnalyticsQueryRequest.
Offset of data
- Returns
The offset of this AdAnalyticsQueryRequest.
- Return type
int
- property openapi_types
- property order_by
Gets the order_by of this AdAnalyticsQueryRequest.
- Returns
The order_by of this AdAnalyticsQueryRequest.
- Return type
list[AdAnalyticsOrderByEntry]
bitmovin_api_sdk.models.ad_analytics_stddev_query_request module
bitmovin_api_sdk.models.ad_analytics_sum_query_request module
bitmovin_api_sdk.models.ad_analytics_variance_query_request module
bitmovin_api_sdk.models.adaptation_set module
- class bitmovin_api_sdk.models.adaptation_set.AdaptationSet(**kwargs)[source]
Bases:
BitmovinResponse- property accessibilities
Gets the accessibilities of this AdaptationSet.
Provide signaling of CEA 607 and CEA 708
- Returns
The accessibilities of this AdaptationSet.
- Return type
list[Accessibility]
- property attribute_map
- property custom_attributes
Gets the custom_attributes of this AdaptationSet.
Custom adaptation set attributes
- Returns
The custom_attributes of this AdaptationSet.
- Return type
list[CustomAttribute]
- discriminator_value_class_map = {'AUDIO': 'AudioAdaptationSet', 'IMAGE': 'ImageAdaptationSet', 'SUBTITLE': 'SubtitleAdaptationSet', 'VIDEO': 'VideoAdaptationSet'}
- property labels
Gets the labels of this AdaptationSet.
List of labels
- Returns
The labels of this AdaptationSet.
- Return type
list[Label]
- property openapi_types
- property roles
Gets the roles of this AdaptationSet.
Roles of the adaptation set
- Returns
The roles of this AdaptationSet.
- Return type
list[AdaptationSetRole]
bitmovin_api_sdk.models.adaptation_set_role module
bitmovin_api_sdk.models.adaptation_set_type module
bitmovin_api_sdk.models.adaptation_set_type_response module
- class bitmovin_api_sdk.models.adaptation_set_type_response.AdaptationSetTypeResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property type
Gets the type of this AdaptationSetTypeResponse.
The type of the adaptation set
- Returns
The type of this AdaptationSetTypeResponse.
- Return type
bitmovin_api_sdk.models.adaptive_quant_mode module
bitmovin_api_sdk.models.aes_encryption_drm module
- class bitmovin_api_sdk.models.aes_encryption_drm.AesEncryptionDrm(**kwargs)[source]
Bases:
Drm- property attribute_map
- property iv
Gets the iv of this AesEncryptionDrm.
16 byte initialization vector
- Returns
The iv of this AesEncryptionDrm.
- Return type
string_types
- property key
Gets the key of this AesEncryptionDrm.
16 byte Encryption key, 32 hexadecimal characters (required)
- Returns
The key of this AesEncryptionDrm.
- Return type
string_types
- property key_file_uri
Gets the key_file_uri of this AesEncryptionDrm.
Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.
- Returns
The key_file_uri of this AesEncryptionDrm.
- Return type
string_types
- property method
Gets the method of this AesEncryptionDrm.
- Returns
The method of this AesEncryptionDrm.
- Return type
- property openapi_types
bitmovin_api_sdk.models.aes_encryption_method module
bitmovin_api_sdk.models.akamai_account module
- class bitmovin_api_sdk.models.akamai_account.AkamaiAccount(**kwargs)[source]
Bases:
BitmovinResource- property api_token
Gets the api_token of this AkamaiAccount.
Akamai/Linode API token (required)
- Returns
The api_token of this AkamaiAccount.
- Return type
string_types
- property attribute_map
- property openapi_types
bitmovin_api_sdk.models.akamai_account_region_settings module
- class bitmovin_api_sdk.models.akamai_account_region_settings.AkamaiAccountRegionSettings(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property firewall_id
Gets the firewall_id of this AkamaiAccountRegionSettings.
Id of the firewall for encoding instances (required)
- Returns
The firewall_id of this AkamaiAccountRegionSettings.
- Return type
int
- property openapi_types
- property region
Gets the region of this AkamaiAccountRegionSettings.
- Returns
The region of this AkamaiAccountRegionSettings.
- Return type
- property subnet_id
Gets the subnet_id of this AkamaiAccountRegionSettings.
Id of the VPC subnet for encoding instances (required)
- Returns
The subnet_id of this AkamaiAccountRegionSettings.
- Return type
int
bitmovin_api_sdk.models.akamai_cloud_region module
- class bitmovin_api_sdk.models.akamai_cloud_region.AkamaiCloudRegion(value)[source]
Bases:
EnumAn enumeration.
- BR_GRU = 'BR_GRU'
- ES_MAD = 'ES_MAD'
- FR_PAR = 'FR_PAR'
- ID_CGK = 'ID_CGK'
- IN_MAA = 'IN_MAA'
- IT_MIL = 'IT_MIL'
- JP_OSA = 'JP_OSA'
- NL_AMS = 'NL_AMS'
- SE_STO = 'SE_STO'
- US_LAX = 'US_LAX'
- US_MIA = 'US_MIA'
- US_ORD = 'US_ORD'
- US_SEA = 'US_SEA'
bitmovin_api_sdk.models.akamai_msl_output module
- class bitmovin_api_sdk.models.akamai_msl_output.AkamaiMslOutput(**kwargs)[source]
Bases:
Output- property attribute_map
- property event_name
Gets the event_name of this AkamaiMslOutput.
The Akamai event name (required)
- Returns
The event_name of this AkamaiMslOutput.
- Return type
string_types
- property msl_version
Gets the msl_version of this AkamaiMslOutput.
The Akamai MSL Version. Only MSL4 is supported at the moment. (required)
- Returns
The msl_version of this AkamaiMslOutput.
- Return type
- property openapi_types
- property stream_format
Gets the stream_format of this AkamaiMslOutput.
DASH: configure the Encoding with fMP4 or CMAF muxings and a DASH manifest. - HLS: configure the Encoding with TS muxings and an HLS manifest. - CMAF: configure the Encoding with fMP4 or CMAF muxings with both DASH and HLS manifests. (required)
- Returns
The stream_format of this AkamaiMslOutput.
- Return type
- property stream_id
Gets the stream_id of this AkamaiMslOutput.
The Akamai stream ID (required)
- Returns
The stream_id of this AkamaiMslOutput.
- Return type
int
bitmovin_api_sdk.models.akamai_msl_stream_format module
bitmovin_api_sdk.models.akamai_msl_version module
bitmovin_api_sdk.models.akamai_net_storage_input module
- class bitmovin_api_sdk.models.akamai_net_storage_input.AkamaiNetStorageInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property host
Gets the host of this AkamaiNetStorageInput.
Host to use for Akamai NetStorage transfers (required)
- Returns
The host of this AkamaiNetStorageInput.
- Return type
string_types
- property openapi_types
- property password
Gets the password of this AkamaiNetStorageInput.
Your Akamai NetStorage password (required)
- Returns
The password of this AkamaiNetStorageInput.
- Return type
string_types
- property username
Gets the username of this AkamaiNetStorageInput.
Your Akamai NetStorage Username (required)
- Returns
The username of this AkamaiNetStorageInput.
- Return type
string_types
bitmovin_api_sdk.models.akamai_net_storage_output module
- class bitmovin_api_sdk.models.akamai_net_storage_output.AkamaiNetStorageOutput(**kwargs)[source]
Bases:
Output- property attribute_map
- property host
Gets the host of this AkamaiNetStorageOutput.
Host to use for Akamai NetStorage transfers (required)
- Returns
The host of this AkamaiNetStorageOutput.
- Return type
string_types
- property openapi_types
- property password
Gets the password of this AkamaiNetStorageOutput.
Your Akamai NetStorage password (required)
- Returns
The password of this AkamaiNetStorageOutput.
- Return type
string_types
- property username
Gets the username of this AkamaiNetStorageOutput.
Your Akamai NetStorage Username (required)
- Returns
The username of this AkamaiNetStorageOutput.
- Return type
string_types
bitmovin_api_sdk.models.analytics_abstract_filter module
- class bitmovin_api_sdk.models.analytics_abstract_filter.AnalyticsAbstractFilter(**kwargs)[source]
Bases:
object- property attribute_map
- discriminator_value_class_map = {'CONTAINS': 'AnalyticsContainsFilter', 'EQ': 'AnalyticsEqualFilter', 'GT': 'AnalyticsGreaterThanFilter', 'GTE': 'AnalyticsGreaterThanOrEqualFilter', 'IN': 'AnalyticsInFilter', 'LT': 'AnalyticsLessThanFilter', 'LTE': 'AnalyticsLessThanOrEqualFilter', 'NE': 'AnalyticsNotEqualFilter', 'NOTCONTAINS': 'AnalyticsNotContainsFilter'}
- property name
Gets the name of this AnalyticsAbstractFilter.
- Returns
The name of this AnalyticsAbstractFilter.
- Return type
- property openapi_types
bitmovin_api_sdk.models.analytics_attribute module
- class bitmovin_api_sdk.models.analytics_attribute.AnalyticsAttribute(value)[source]
Bases:
EnumAn enumeration.
- ACTIVE_PLAYER_STARTUPTIME = 'ACTIVE_PLAYER_STARTUPTIME'
- AD = 'AD'
- ANALYTICS_VERSION = 'ANALYTICS_VERSION'
- AUDIO_BITRATE = 'AUDIO_BITRATE'
- AUDIO_CODEC = 'AUDIO_CODEC'
- AUTOPLAY = 'AUTOPLAY'
- BROWSER = 'BROWSER'
- BROWSER_IS_BOT = 'BROWSER_IS_BOT'
- BROWSER_VERSION_MAJOR = 'BROWSER_VERSION_MAJOR'
- BUFFERED = 'BUFFERED'
- CAST_TECH = 'CAST_TECH'
- CDN_PROVIDER = 'CDN_PROVIDER'
- CITY = 'CITY'
- CLIENT_TIME = 'CLIENT_TIME'
- COUNTRY = 'COUNTRY'
- CUSTOM_DATA_1 = 'CUSTOM_DATA_1'
- CUSTOM_DATA_10 = 'CUSTOM_DATA_10'
- CUSTOM_DATA_11 = 'CUSTOM_DATA_11'
- CUSTOM_DATA_12 = 'CUSTOM_DATA_12'
- CUSTOM_DATA_13 = 'CUSTOM_DATA_13'
- CUSTOM_DATA_14 = 'CUSTOM_DATA_14'
- CUSTOM_DATA_15 = 'CUSTOM_DATA_15'
- CUSTOM_DATA_16 = 'CUSTOM_DATA_16'
- CUSTOM_DATA_17 = 'CUSTOM_DATA_17'
- CUSTOM_DATA_18 = 'CUSTOM_DATA_18'
- CUSTOM_DATA_19 = 'CUSTOM_DATA_19'
- CUSTOM_DATA_2 = 'CUSTOM_DATA_2'
- CUSTOM_DATA_20 = 'CUSTOM_DATA_20'
- CUSTOM_DATA_21 = 'CUSTOM_DATA_21'
- CUSTOM_DATA_22 = 'CUSTOM_DATA_22'
- CUSTOM_DATA_23 = 'CUSTOM_DATA_23'
- CUSTOM_DATA_24 = 'CUSTOM_DATA_24'
- CUSTOM_DATA_25 = 'CUSTOM_DATA_25'
- CUSTOM_DATA_26 = 'CUSTOM_DATA_26'
- CUSTOM_DATA_27 = 'CUSTOM_DATA_27'
- CUSTOM_DATA_28 = 'CUSTOM_DATA_28'
- CUSTOM_DATA_29 = 'CUSTOM_DATA_29'
- CUSTOM_DATA_3 = 'CUSTOM_DATA_3'
- CUSTOM_DATA_30 = 'CUSTOM_DATA_30'
- CUSTOM_DATA_4 = 'CUSTOM_DATA_4'
- CUSTOM_DATA_5 = 'CUSTOM_DATA_5'
- CUSTOM_DATA_6 = 'CUSTOM_DATA_6'
- CUSTOM_DATA_7 = 'CUSTOM_DATA_7'
- CUSTOM_DATA_8 = 'CUSTOM_DATA_8'
- CUSTOM_DATA_9 = 'CUSTOM_DATA_9'
- CUSTOM_USER_ID = 'CUSTOM_USER_ID'
- DAY = 'DAY'
- DEVICE_CLASS = 'DEVICE_CLASS'
- DEVICE_TYPE = 'DEVICE_TYPE'
- DOMAIN = 'DOMAIN'
- DRM_LOAD_TIME = 'DRM_LOAD_TIME'
- DRM_TYPE = 'DRM_TYPE'
- DROPPED_FRAMES = 'DROPPED_FRAMES'
- DURATION = 'DURATION'
- ERROR_CODE = 'ERROR_CODE'
- ERROR_MESSAGE = 'ERROR_MESSAGE'
- ERROR_PERCENTAGE = 'ERROR_PERCENTAGE'
- ERROR_RATE = 'ERROR_RATE'
- EXPERIMENT_NAME = 'EXPERIMENT_NAME'
- FUNCTION = 'FUNCTION'
- HOUR = 'HOUR'
- IMPRESSION_ID = 'IMPRESSION_ID'
- INITIAL_TIME_TO_TARGET_LATENCY = 'INITIAL_TIME_TO_TARGET_LATENCY'
- IP_ADDRESS = 'IP_ADDRESS'
- ISP = 'ISP'
- IS_CASTING = 'IS_CASTING'
- IS_LIVE = 'IS_LIVE'
- IS_LOW_LATENCY = 'IS_LOW_LATENCY'
- IS_MUTED = 'IS_MUTED'
- LANGUAGE = 'LANGUAGE'
- LATENCY = 'LATENCY'
- LICENSE_KEY = 'LICENSE_KEY'
- M3U8_URL = 'M3U8_URL'
- MINUTE = 'MINUTE'
- MONTH = 'MONTH'
- MPD_URL = 'MPD_URL'
- OPERATINGSYSTEM = 'OPERATINGSYSTEM'
- OPERATINGSYSTEM_VERSION_MAJOR = 'OPERATINGSYSTEM_VERSION_MAJOR'
- PAGE_LOAD_TIME = 'PAGE_LOAD_TIME'
- PAGE_LOAD_TYPE = 'PAGE_LOAD_TYPE'
- PATH = 'PATH'
- PAUSED = 'PAUSED'
- PLATFORM = 'PLATFORM'
- PLAYED = 'PLAYED'
- PLAYER = 'PLAYER'
- PLAYER_KEY = 'PLAYER_KEY'
- PLAYER_STARTUPTIME = 'PLAYER_STARTUPTIME'
- PLAYER_TECH = 'PLAYER_TECH'
- PLAYER_VERSION = 'PLAYER_VERSION'
- PROG_URL = 'PROG_URL'
- REBUFFER_PERCENTAGE = 'REBUFFER_PERCENTAGE'
- REGION = 'REGION'
- SCALE_FACTOR = 'SCALE_FACTOR'
- SCREEN_HEIGHT = 'SCREEN_HEIGHT'
- SCREEN_ORIENTATION = 'SCREEN_ORIENTATION'
- SCREEN_WIDTH = 'SCREEN_WIDTH'
- SEEKED = 'SEEKED'
- SEQUENCE_NUMBER = 'SEQUENCE_NUMBER'
- SIZE = 'SIZE'
- STARTUPTIME = 'STARTUPTIME'
- STREAM_FORMAT = 'STREAM_FORMAT'
- SUPPORTED_VIDEO_CODECS = 'SUPPORTED_VIDEO_CODECS'
- TARGET_LATENCY = 'TARGET_LATENCY'
- TARGET_LATENCY_DELTA = 'TARGET_LATENCY_DELTA'
- TIME = 'TIME'
- TIME_TO_TARGET_LATENCY = 'TIME_TO_TARGET_LATENCY'
- USER_ID = 'USER_ID'
- VIDEOSTART_FAILED = 'VIDEOSTART_FAILED'
- VIDEOSTART_FAILED_REASON = 'VIDEOSTART_FAILED_REASON'
- VIDEOTIME_END = 'VIDEOTIME_END'
- VIDEOTIME_START = 'VIDEOTIME_START'
- VIDEO_BITRATE = 'VIDEO_BITRATE'
- VIDEO_CODEC = 'VIDEO_CODEC'
- VIDEO_DURATION = 'VIDEO_DURATION'
- VIDEO_ID = 'VIDEO_ID'
- VIDEO_PLAYBACK_HEIGHT = 'VIDEO_PLAYBACK_HEIGHT'
- VIDEO_PLAYBACK_WIDTH = 'VIDEO_PLAYBACK_WIDTH'
- VIDEO_STARTUPTIME = 'VIDEO_STARTUPTIME'
- VIDEO_TITLE = 'VIDEO_TITLE'
- VIDEO_WINDOW_HEIGHT = 'VIDEO_WINDOW_HEIGHT'
- VIDEO_WINDOW_WIDTH = 'VIDEO_WINDOW_WIDTH'
- VIEWTIME = 'VIEWTIME'
bitmovin_api_sdk.models.analytics_avg_concurrent_viewers_response module
- class bitmovin_api_sdk.models.analytics_avg_concurrent_viewers_response.AnalyticsAvgConcurrentViewersResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property column_labels
Gets the column_labels of this AnalyticsAvgConcurrentViewersResponse.
- Returns
The column_labels of this AnalyticsAvgConcurrentViewersResponse.
- Return type
list[AnalyticsColumnLabel]
- property openapi_types
- property row_count
Gets the row_count of this AnalyticsAvgConcurrentViewersResponse.
Number of rows returned
- Returns
The row_count of this AnalyticsAvgConcurrentViewersResponse.
- Return type
int
- property rows
Gets the rows of this AnalyticsAvgConcurrentViewersResponse.
- Returns
The rows of this AnalyticsAvgConcurrentViewersResponse.
- Return type
list[float]
bitmovin_api_sdk.models.analytics_avg_dropped_frames_response module
- class bitmovin_api_sdk.models.analytics_avg_dropped_frames_response.AnalyticsAvgDroppedFramesResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property column_labels
Gets the column_labels of this AnalyticsAvgDroppedFramesResponse.
- Returns
The column_labels of this AnalyticsAvgDroppedFramesResponse.
- Return type
list[AnalyticsColumnLabel]
- property openapi_types
- property row_count
Gets the row_count of this AnalyticsAvgDroppedFramesResponse.
Number of rows returned
- Returns
The row_count of this AnalyticsAvgDroppedFramesResponse.
- Return type
int
- property rows
Gets the rows of this AnalyticsAvgDroppedFramesResponse.
- Returns
The rows of this AnalyticsAvgDroppedFramesResponse.
- Return type
list[float]
bitmovin_api_sdk.models.analytics_avg_query_request module
bitmovin_api_sdk.models.analytics_azure_output module
- class bitmovin_api_sdk.models.analytics_azure_output.AnalyticsAzureOutput(**kwargs)[source]
Bases:
AnalyticsOutput- property account_key
Gets the account_key of this AnalyticsAzureOutput.
Microsoft Azure Account Access Key with the Contributor Role (required)
- Returns
The account_key of this AnalyticsAzureOutput.
- Return type
string_types
- property account_name
Gets the account_name of this AnalyticsAzureOutput.
Azure Account Name (required)
- Returns
The account_name of this AnalyticsAzureOutput.
- Return type
string_types
- property attribute_map
- property container
Gets the container of this AnalyticsAzureOutput.
Microsoft Azure container name (required)
- Returns
The container of this AnalyticsAzureOutput.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.analytics_column_label module
- class bitmovin_api_sdk.models.analytics_column_label.AnalyticsColumnLabel(**kwargs)[source]
Bases:
object- property attribute_map
- property key
Gets the key of this AnalyticsColumnLabel.
- Returns
The key of this AnalyticsColumnLabel.
- Return type
string_types
- property label
Gets the label of this AnalyticsColumnLabel.
- Returns
The label of this AnalyticsColumnLabel.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.analytics_contains_filter module
- class bitmovin_api_sdk.models.analytics_contains_filter.AnalyticsContainsFilter(**kwargs)[source]
Bases:
AnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AnalyticsContainsFilter.
- Returns
The value of this AnalyticsContainsFilter.
- Return type
object
bitmovin_api_sdk.models.analytics_context_description module
- class bitmovin_api_sdk.models.analytics_context_description.AnalyticsContextDescription(**kwargs)[source]
Bases:
object- property attribute_map
- property description
Gets the description of this AnalyticsContextDescription.
- Returns
The description of this AnalyticsContextDescription.
- Return type
string_types
- property label
Gets the label of this AnalyticsContextDescription.
- Returns
The label of this AnalyticsContextDescription.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.analytics_count_query_request module
bitmovin_api_sdk.models.analytics_equal_filter module
bitmovin_api_sdk.models.analytics_error_data module
- class bitmovin_api_sdk.models.analytics_error_data.AnalyticsErrorData(**kwargs)[source]
Bases:
object- property additional_data
Gets the additional_data of this AnalyticsErrorData.
Additional error data
- Returns
The additional_data of this AnalyticsErrorData.
- Return type
string_types
- property attribute_map
- property exception_message
Gets the exception_message of this AnalyticsErrorData.
Exception message
- Returns
The exception_message of this AnalyticsErrorData.
- Return type
string_types
- property exception_stacktrace
Gets the exception_stacktrace of this AnalyticsErrorData.
- Returns
The exception_stacktrace of this AnalyticsErrorData.
- Return type
list[string_types]
- property openapi_types
bitmovin_api_sdk.models.analytics_error_detail module
- class bitmovin_api_sdk.models.analytics_error_detail.AnalyticsErrorDetail(**kwargs)[source]
Bases:
object- property attribute_map
- property client_time
Gets the client_time of this AnalyticsErrorDetail.
Client timestamp
- Returns
The client_time of this AnalyticsErrorDetail.
- Return type
datetime
- property code
Gets the code of this AnalyticsErrorDetail.
Error code
- Returns
The code of this AnalyticsErrorDetail.
- Return type
int
- property error_data
Gets the error_data of this AnalyticsErrorDetail.
- Returns
The error_data of this AnalyticsErrorDetail.
- Return type
- property error_id
Gets the error_id of this AnalyticsErrorDetail.
Error id
- Returns
The error_id of this AnalyticsErrorDetail.
- Return type
int
- property http_requests
Gets the http_requests of this AnalyticsErrorDetail.
- Returns
The http_requests of this AnalyticsErrorDetail.
- Return type
list[AnalyticsHttpRequest]
- property message
Gets the message of this AnalyticsErrorDetail.
Error message
- Returns
The message of this AnalyticsErrorDetail.
- Return type
string_types
- property openapi_types
- property time
Gets the time of this AnalyticsErrorDetail.
Server timestamp
- Returns
The time of this AnalyticsErrorDetail.
- Return type
datetime
bitmovin_api_sdk.models.analytics_error_details_response module
- class bitmovin_api_sdk.models.analytics_error_details_response.AnalyticsErrorDetailsResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property error_details
Gets the error_details of this AnalyticsErrorDetailsResponse.
- Returns
The error_details of this AnalyticsErrorDetailsResponse.
- Return type
list[AnalyticsErrorDetail]
- property openapi_types
bitmovin_api_sdk.models.analytics_export_file_format module
bitmovin_api_sdk.models.analytics_export_status module
bitmovin_api_sdk.models.analytics_export_task module
- class bitmovin_api_sdk.models.analytics_export_task.AnalyticsExportTask(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property columns
Gets the columns of this AnalyticsExportTask.
- Returns
The columns of this AnalyticsExportTask.
- Return type
list[string_types]
- property description
Gets the description of this AnalyticsExportTask.
Export task description
- Returns
The description of this AnalyticsExportTask.
- Return type
string_types
- property end_time
Gets the end_time of this AnalyticsExportTask.
End of timeframe which is exported in UTC format (required)
- Returns
The end_time of this AnalyticsExportTask.
- Return type
datetime
- property file_format
Gets the file_format of this AnalyticsExportTask.
File format of export file
- Returns
The file_format of this AnalyticsExportTask.
- Return type
- property finished_at
Gets the finished_at of this AnalyticsExportTask.
UTC timestamp when the export task finished
- Returns
The finished_at of this AnalyticsExportTask.
- Return type
datetime
- property license_key
Gets the license_key of this AnalyticsExportTask.
License key (required)
- Returns
The license_key of this AnalyticsExportTask.
- Return type
string_types
- property name
Gets the name of this AnalyticsExportTask.
Name of the export task (required)
- Returns
The name of this AnalyticsExportTask.
- Return type
string_types
- property openapi_types
- property output
Gets the output of this AnalyticsExportTask.
- Returns
The output of this AnalyticsExportTask.
- Return type
- property progress
Gets the progress of this AnalyticsExportTask.
Progress of the export task
- Returns
The progress of this AnalyticsExportTask.
- Return type
int
- property start_time
Gets the start_time of this AnalyticsExportTask.
Start of timeframe which is exported in UTC format (required)
- Returns
The start_time of this AnalyticsExportTask.
- Return type
datetime
- property started_at
Gets the started_at of this AnalyticsExportTask.
UTC timestamp when the export task started
- Returns
The started_at of this AnalyticsExportTask.
- Return type
datetime
- property status
Gets the status of this AnalyticsExportTask.
- Returns
The status of this AnalyticsExportTask.
- Return type
- property type
Gets the type of this AnalyticsExportTask.
- Returns
The type of this AnalyticsExportTask.
- Return type
bitmovin_api_sdk.models.analytics_export_task_output_target module
- class bitmovin_api_sdk.models.analytics_export_task_output_target.AnalyticsExportTaskOutputTarget(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property output_id
Gets the output_id of this AnalyticsExportTaskOutputTarget.
Id of the output that should be used (required)
- Returns
The output_id of this AnalyticsExportTaskOutputTarget.
- Return type
string_types
- property output_path
Gets the output_path of this AnalyticsExportTaskOutputTarget.
Path where the export should be saved (required)
- Returns
The output_path of this AnalyticsExportTaskOutputTarget.
- Return type
string_types
bitmovin_api_sdk.models.analytics_export_type module
bitmovin_api_sdk.models.analytics_gcs_service_account_output module
- class bitmovin_api_sdk.models.analytics_gcs_service_account_output.AnalyticsGcsServiceAccountOutput(**kwargs)[source]
Bases:
AnalyticsOutput- property attribute_map
- property bucket_name
Gets the bucket_name of this AnalyticsGcsServiceAccountOutput.
Name of the bucket (required)
- Returns
The bucket_name of this AnalyticsGcsServiceAccountOutput.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this AnalyticsGcsServiceAccountOutput.
The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.
- Returns
The cloud_region of this AnalyticsGcsServiceAccountOutput.
- Return type
- property openapi_types
- property service_account_credentials
Gets the service_account_credentials of this AnalyticsGcsServiceAccountOutput.
GCS projectId (required)
- Returns
The service_account_credentials of this AnalyticsGcsServiceAccountOutput.
- Return type
string_types
bitmovin_api_sdk.models.analytics_greater_than_filter module
- class bitmovin_api_sdk.models.analytics_greater_than_filter.AnalyticsGreaterThanFilter(**kwargs)[source]
Bases:
AnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AnalyticsGreaterThanFilter.
- Returns
The value of this AnalyticsGreaterThanFilter.
- Return type
object
bitmovin_api_sdk.models.analytics_greater_than_or_equal_filter module
- class bitmovin_api_sdk.models.analytics_greater_than_or_equal_filter.AnalyticsGreaterThanOrEqualFilter(**kwargs)[source]
Bases:
AnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AnalyticsGreaterThanOrEqualFilter.
- Returns
The value of this AnalyticsGreaterThanOrEqualFilter.
- Return type
object
bitmovin_api_sdk.models.analytics_http_request module
- class bitmovin_api_sdk.models.analytics_http_request.AnalyticsHttpRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property client_time
Gets the client_time of this AnalyticsHttpRequest.
Client timestamp
- Returns
The client_time of this AnalyticsHttpRequest.
- Return type
datetime
- property download_time
Gets the download_time of this AnalyticsHttpRequest.
Download time
- Returns
The download_time of this AnalyticsHttpRequest.
- Return type
int
- property http_status
Gets the http_status of this AnalyticsHttpRequest.
Http request status
- Returns
The http_status of this AnalyticsHttpRequest.
- Return type
int
- property last_redirect_location
Gets the last_redirect_location of this AnalyticsHttpRequest.
Last redirect location
- Returns
The last_redirect_location of this AnalyticsHttpRequest.
- Return type
string_types
- property openapi_types
- property size
Gets the size of this AnalyticsHttpRequest.
Size
- Returns
The size of this AnalyticsHttpRequest.
- Return type
int
- property success
Gets the success of this AnalyticsHttpRequest.
Was http request successful
- Returns
The success of this AnalyticsHttpRequest.
- Return type
bool
- property time_to_first_byte
Gets the time_to_first_byte of this AnalyticsHttpRequest.
Time to first byte
- Returns
The time_to_first_byte of this AnalyticsHttpRequest.
- Return type
int
- property type
Gets the type of this AnalyticsHttpRequest.
- Returns
The type of this AnalyticsHttpRequest.
- Return type
- property url
Gets the url of this AnalyticsHttpRequest.
Http request URL
- Returns
The url of this AnalyticsHttpRequest.
- Return type
string_types
bitmovin_api_sdk.models.analytics_http_request_type module
- class bitmovin_api_sdk.models.analytics_http_request_type.AnalyticsHttpRequestType(value)[source]
Bases:
EnumAn enumeration.
- DRM_LICENSE_WIDEVINE_ = 'DRM_LICENSE_WIDEVINE,'
- KEY_HLS_AES_ = 'KEY_HLS_AES,'
- MANIFEST_DASH_ = 'MANIFEST_DASH,'
- MANIFEST_HLS_MASTER_ = 'MANIFEST_HLS_MASTER,'
- MANIFEST_HLS_VARIANT_ = 'MANIFEST_HLS_VARIANT,'
- MANIFEST_SMOOTH_ = 'MANIFEST_SMOOTH,'
- MEDIA_AUDIO_ = 'MEDIA_AUDIO,'
- MEDIA_PROGRESSIVE_ = 'MEDIA_PROGRESSIVE,'
- MEDIA_SUBTITLES_ = 'MEDIA_SUBTITLES,'
- MEDIA_THUMBNAILS_ = 'MEDIA_THUMBNAILS,'
- MEDIA_VIDEO_ = 'MEDIA_VIDEO,'
- UNKNOWN = 'UNKNOWN'
bitmovin_api_sdk.models.analytics_impression_list_item module
- class bitmovin_api_sdk.models.analytics_impression_list_item.AnalyticsImpressionListItem(**kwargs)[source]
Bases:
object- property attribute_map
- property impression_id
Gets the impression_id of this AnalyticsImpressionListItem.
Random UUID that is used to identify a session (required)
- Returns
The impression_id of this AnalyticsImpressionListItem.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.analytics_impressions_query module
- class bitmovin_api_sdk.models.analytics_impressions_query.AnalyticsImpressionsQuery(**kwargs)[source]
Bases:
AnalyticsQueryTimeframe- property attribute_map
- property filters
Gets the filters of this AnalyticsImpressionsQuery.
Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]
- Returns
The filters of this AnalyticsImpressionsQuery.
- Return type
list[AnalyticsAbstractFilter]
- property license_key
Gets the license_key of this AnalyticsImpressionsQuery.
Analytics license key (required)
- Returns
The license_key of this AnalyticsImpressionsQuery.
- Return type
string_types
- property limit
Gets the limit of this AnalyticsImpressionsQuery.
Number of returned impressions
- Returns
The limit of this AnalyticsImpressionsQuery.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.analytics_impressions_response module
- class bitmovin_api_sdk.models.analytics_impressions_response.AnalyticsImpressionsResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property impressions
Gets the impressions of this AnalyticsImpressionsResponse.
- Returns
The impressions of this AnalyticsImpressionsResponse.
- Return type
- property openapi_types
bitmovin_api_sdk.models.analytics_in_filter module
bitmovin_api_sdk.models.analytics_insights_organization_settings module
- class bitmovin_api_sdk.models.analytics_insights_organization_settings.AnalyticsInsightsOrganizationSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property include_in_insights
Gets the include_in_insights of this AnalyticsInsightsOrganizationSettings.
Whether the organization’s data is included in the industry insights
- Returns
The include_in_insights of this AnalyticsInsightsOrganizationSettings.
- Return type
bool
- property industry
Gets the industry of this AnalyticsInsightsOrganizationSettings.
Industry of the organization
- Returns
The industry of this AnalyticsInsightsOrganizationSettings.
- Return type
string_types
- property is_trial
Gets the is_trial of this AnalyticsInsightsOrganizationSettings.
Whether the organization is on an analytics trial plan
- Returns
The is_trial of this AnalyticsInsightsOrganizationSettings.
- Return type
bool
- property openapi_types
- property org_id
Gets the org_id of this AnalyticsInsightsOrganizationSettings.
Organization ID
- Returns
The org_id of this AnalyticsInsightsOrganizationSettings.
- Return type
string_types
- property sub_industry
Gets the sub_industry of this AnalyticsInsightsOrganizationSettings.
Subindustry of the organization
- Returns
The sub_industry of this AnalyticsInsightsOrganizationSettings.
- Return type
string_types
bitmovin_api_sdk.models.analytics_insights_organization_settings_request module
- class bitmovin_api_sdk.models.analytics_insights_organization_settings_request.AnalyticsInsightsOrganizationSettingsRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property include_in_insights
Gets the include_in_insights of this AnalyticsInsightsOrganizationSettingsRequest.
Whether the organization’s data is being contributed to industry insights
- Returns
The include_in_insights of this AnalyticsInsightsOrganizationSettingsRequest.
- Return type
bool
- property openapi_types
bitmovin_api_sdk.models.analytics_interval module
bitmovin_api_sdk.models.analytics_less_than_filter module
- class bitmovin_api_sdk.models.analytics_less_than_filter.AnalyticsLessThanFilter(**kwargs)[source]
Bases:
AnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AnalyticsLessThanFilter.
- Returns
The value of this AnalyticsLessThanFilter.
- Return type
object
bitmovin_api_sdk.models.analytics_less_than_or_equal_filter module
- class bitmovin_api_sdk.models.analytics_less_than_or_equal_filter.AnalyticsLessThanOrEqualFilter(**kwargs)[source]
Bases:
AnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AnalyticsLessThanOrEqualFilter.
- Returns
The value of this AnalyticsLessThanOrEqualFilter.
- Return type
object
bitmovin_api_sdk.models.analytics_license module
- class bitmovin_api_sdk.models.analytics_license.AnalyticsLicense(**kwargs)[source]
Bases:
object- property attribute_map
- property compressed_retention_time
Gets the compressed_retention_time of this AnalyticsLicense.
Retention time for compressed data, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S
- Returns
The compressed_retention_time of this AnalyticsLicense.
- Return type
string_types
- property created_at
Gets the created_at of this AnalyticsLicense.
Creation date of the Analytics License, returned as ISO 8601 date-time format
- Returns
The created_at of this AnalyticsLicense.
- Return type
datetime
- property custom_data
Gets the custom_data of this AnalyticsLicense.
User-specific meta data. This can hold anything.
- Returns
The custom_data of this AnalyticsLicense.
- Return type
dict(str, object)
- property custom_data_field_labels
Gets the custom_data_field_labels of this AnalyticsLicense.
Labels for CustomData fields
- Returns
The custom_data_field_labels of this AnalyticsLicense.
- Return type
- property custom_data_fields_count
Gets the custom_data_fields_count of this AnalyticsLicense.
The number of customData fields available
- Returns
The custom_data_fields_count of this AnalyticsLicense.
- Return type
int
- property domains
Gets the domains of this AnalyticsLicense.
Whitelisted domains
- Returns
The domains of this AnalyticsLicense.
- Return type
list[AnalyticsLicenseDomain]
- property features
Gets the features of this AnalyticsLicense.
- Returns
The features of this AnalyticsLicense.
- Return type
- property id
Gets the id of this AnalyticsLicense.
Id of the Analytics License
- Returns
The id of this AnalyticsLicense.
- Return type
string_types
- property ignore_dnt
Gets the ignore_dnt of this AnalyticsLicense.
Whether the Do Not Track request from the browser should be ignored
- Returns
The ignore_dnt of this AnalyticsLicense.
- Return type
bool
- property impressions
Gets the impressions of this AnalyticsLicense.
Number of impressions recorded
- Returns
The impressions of this AnalyticsLicense.
- Return type
int
- property include_in_insights
Gets the include_in_insights of this AnalyticsLicense.
Whether the data of this license should be included in the industry insights or not
- Returns
The include_in_insights of this AnalyticsLicense.
- Return type
bool
- property industry
Gets the industry of this AnalyticsLicense.
The industry of the organization associated with the Analytics License
- Returns
The industry of this AnalyticsLicense.
- Return type
string_types
- property license_key
Gets the license_key of this AnalyticsLicense.
License Key
- Returns
The license_key of this AnalyticsLicense.
- Return type
string_types
- property max_impressions
Gets the max_impressions of this AnalyticsLicense.
Maximum number of impressions
- Returns
The max_impressions of this AnalyticsLicense.
- Return type
int
- property name
Gets the name of this AnalyticsLicense.
Name of the Analytics License
- Returns
The name of this AnalyticsLicense.
- Return type
string_types
- property openapi_types
- property order_index
Gets the order_index of this AnalyticsLicense.
Order index of license
- Returns
The order_index of this AnalyticsLicense.
- Return type
int
- property plan_expired_at
Gets the plan_expired_at of this AnalyticsLicense.
The expiration date of the license if applicable, returned as ISO 8601 date-time format
- Returns
The plan_expired_at of this AnalyticsLicense.
- Return type
datetime
- property rate_limit
Gets the rate_limit of this AnalyticsLicense.
The rate limit of this license
- Returns
The rate_limit of this AnalyticsLicense.
- Return type
string_types
- property retention_time
Gets the retention_time of this AnalyticsLicense.
Retention time of impressions, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S
- Returns
The retention_time of this AnalyticsLicense.
- Return type
string_types
- property sub_industry
Gets the sub_industry of this AnalyticsLicense.
The subindustry of the organization associated with the Analytics License
- Returns
The sub_industry of this AnalyticsLicense.
- Return type
string_types
- property time_zone
Gets the time_zone of this AnalyticsLicense.
The timezone of the Analytics License
- Returns
The time_zone of this AnalyticsLicense.
- Return type
string_types
bitmovin_api_sdk.models.analytics_license_custom_data_field_labels module
- class bitmovin_api_sdk.models.analytics_license_custom_data_field_labels.AnalyticsLicenseCustomDataFieldLabels(**kwargs)[source]
Bases:
object- property attribute_map
- property custom_data1
Gets the custom_data1 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 1
- Returns
The custom_data1 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data10
Gets the custom_data10 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 10
- Returns
The custom_data10 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data11
Gets the custom_data11 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 11
- Returns
The custom_data11 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data12
Gets the custom_data12 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 12
- Returns
The custom_data12 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data13
Gets the custom_data13 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 13
- Returns
The custom_data13 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data14
Gets the custom_data14 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 14
- Returns
The custom_data14 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data15
Gets the custom_data15 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 15
- Returns
The custom_data15 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data16
Gets the custom_data16 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 16
- Returns
The custom_data16 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data17
Gets the custom_data17 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 17
- Returns
The custom_data17 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data18
Gets the custom_data18 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 18
- Returns
The custom_data18 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data19
Gets the custom_data19 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 19
- Returns
The custom_data19 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data2
Gets the custom_data2 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 2
- Returns
The custom_data2 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data20
Gets the custom_data20 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 20
- Returns
The custom_data20 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data21
Gets the custom_data21 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 21
- Returns
The custom_data21 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data22
Gets the custom_data22 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 22
- Returns
The custom_data22 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data23
Gets the custom_data23 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 23
- Returns
The custom_data23 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data24
Gets the custom_data24 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 24
- Returns
The custom_data24 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data25
Gets the custom_data25 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 25
- Returns
The custom_data25 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data26
Gets the custom_data26 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 26
- Returns
The custom_data26 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data27
Gets the custom_data27 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 27
- Returns
The custom_data27 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data28
Gets the custom_data28 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 28
- Returns
The custom_data28 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data29
Gets the custom_data29 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 29
- Returns
The custom_data29 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data3
Gets the custom_data3 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 3
- Returns
The custom_data3 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data30
Gets the custom_data30 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 30
- Returns
The custom_data30 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data4
Gets the custom_data4 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 4
- Returns
The custom_data4 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data5
Gets the custom_data5 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 5
- Returns
The custom_data5 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data6
Gets the custom_data6 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 6
- Returns
The custom_data6 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data7
Gets the custom_data7 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 7
- Returns
The custom_data7 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data8
Gets the custom_data8 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 8
- Returns
The custom_data8 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property custom_data9
Gets the custom_data9 of this AnalyticsLicenseCustomDataFieldLabels.
Label for field Custom Data 9
- Returns
The custom_data9 of this AnalyticsLicenseCustomDataFieldLabels.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.analytics_license_domain module
- class bitmovin_api_sdk.models.analytics_license_domain.AnalyticsLicenseDomain(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property openapi_types
- property url
Gets the url of this AnalyticsLicenseDomain.
- Returns
The url of this AnalyticsLicenseDomain.
- Return type
string_types
bitmovin_api_sdk.models.analytics_license_error_details_config module
- class bitmovin_api_sdk.models.analytics_license_error_details_config.AnalyticsLicenseErrorDetailsConfig(**kwargs)[source]
Bases:
object- property attribute_map
- property enabled
Gets the enabled of this AnalyticsLicenseErrorDetailsConfig.
Are error details enabled on the license
- Returns
The enabled of this AnalyticsLicenseErrorDetailsConfig.
- Return type
bool
- property network_explorer_enabled
Gets the network_explorer_enabled of this AnalyticsLicenseErrorDetailsConfig.
Is network explorer feature enabled for the license
- Returns
The network_explorer_enabled of this AnalyticsLicenseErrorDetailsConfig.
- Return type
bool
- property openapi_types
bitmovin_api_sdk.models.analytics_license_features module
- class bitmovin_api_sdk.models.analytics_license_features.AnalyticsLicenseFeatures(**kwargs)[source]
Bases:
object- property attribute_map
- property error_details
Gets the error_details of this AnalyticsLicenseFeatures.
- Returns
The error_details of this AnalyticsLicenseFeatures.
- Return type
- property openapi_types
bitmovin_api_sdk.models.analytics_license_key module
- class bitmovin_api_sdk.models.analytics_license_key.AnalyticsLicenseKey(**kwargs)[source]
Bases:
object- property attribute_map
- property license_key
Gets the license_key of this AnalyticsLicenseKey.
Analytics License Key (required)
- Returns
The license_key of this AnalyticsLicenseKey.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.analytics_max_concurrent_viewers_response module
- class bitmovin_api_sdk.models.analytics_max_concurrent_viewers_response.AnalyticsMaxConcurrentViewersResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property column_labels
Gets the column_labels of this AnalyticsMaxConcurrentViewersResponse.
- Returns
The column_labels of this AnalyticsMaxConcurrentViewersResponse.
- Return type
list[AnalyticsColumnLabel]
- property openapi_types
- property row_count
Gets the row_count of this AnalyticsMaxConcurrentViewersResponse.
Number of rows returned
- Returns
The row_count of this AnalyticsMaxConcurrentViewersResponse.
- Return type
int
- property rows
Gets the rows of this AnalyticsMaxConcurrentViewersResponse.
- Returns
The rows of this AnalyticsMaxConcurrentViewersResponse.
- Return type
list[float]
bitmovin_api_sdk.models.analytics_max_query_request module
bitmovin_api_sdk.models.analytics_median_query_request module
bitmovin_api_sdk.models.analytics_metrics_query_request module
- class bitmovin_api_sdk.models.analytics_metrics_query_request.AnalyticsMetricsQueryRequest(**kwargs)[source]
Bases:
AnalyticsQueryTimeframe- property attribute_map
- property filters
Gets the filters of this AnalyticsMetricsQueryRequest.
- Returns
The filters of this AnalyticsMetricsQueryRequest.
- Return type
list[AnalyticsAbstractFilter]
- property group_by
Gets the group_by of this AnalyticsMetricsQueryRequest.
- Returns
The group_by of this AnalyticsMetricsQueryRequest.
- Return type
list[AnalyticsAttribute]
- property interval
Gets the interval of this AnalyticsMetricsQueryRequest.
- Returns
The interval of this AnalyticsMetricsQueryRequest.
- Return type
- property license_key
Gets the license_key of this AnalyticsMetricsQueryRequest.
Analytics license key (required)
- Returns
The license_key of this AnalyticsMetricsQueryRequest.
- Return type
string_types
- property limit
Gets the limit of this AnalyticsMetricsQueryRequest.
Maximum number of rows returned (max. 200)
- Returns
The limit of this AnalyticsMetricsQueryRequest.
- Return type
int
- property offset
Gets the offset of this AnalyticsMetricsQueryRequest.
Offset of data used for pagination
- Returns
The offset of this AnalyticsMetricsQueryRequest.
- Return type
int
- property openapi_types
- property order_by
Gets the order_by of this AnalyticsMetricsQueryRequest.
- Returns
The order_by of this AnalyticsMetricsQueryRequest.
- Return type
list[AnalyticsOrderByEntry]
bitmovin_api_sdk.models.analytics_min_query_request module
bitmovin_api_sdk.models.analytics_not_contains_filter module
- class bitmovin_api_sdk.models.analytics_not_contains_filter.AnalyticsNotContainsFilter(**kwargs)[source]
Bases:
AnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AnalyticsNotContainsFilter.
- Returns
The value of this AnalyticsNotContainsFilter.
- Return type
object
bitmovin_api_sdk.models.analytics_not_equal_filter module
- class bitmovin_api_sdk.models.analytics_not_equal_filter.AnalyticsNotEqualFilter(**kwargs)[source]
Bases:
AnalyticsAbstractFilter- property attribute_map
- property openapi_types
- property value
Gets the value of this AnalyticsNotEqualFilter.
- Returns
The value of this AnalyticsNotEqualFilter.
- Return type
object
bitmovin_api_sdk.models.analytics_order module
bitmovin_api_sdk.models.analytics_order_by_entry module
- class bitmovin_api_sdk.models.analytics_order_by_entry.AnalyticsOrderByEntry(**kwargs)[source]
Bases:
object- property attribute_map
- property name
Gets the name of this AnalyticsOrderByEntry.
- Returns
The name of this AnalyticsOrderByEntry.
- Return type
- property openapi_types
- property order
Gets the order of this AnalyticsOrderByEntry.
- Returns
The order of this AnalyticsOrderByEntry.
- Return type
bitmovin_api_sdk.models.analytics_output module
- class bitmovin_api_sdk.models.analytics_output.AnalyticsOutput(**kwargs)[source]
Bases:
BitmovinResource- property acl
Gets the acl of this AnalyticsOutput.
- Returns
The acl of this AnalyticsOutput.
- Return type
list[AclEntry]
- property attribute_map
- discriminator_value_class_map = {'AZURE': 'AnalyticsAzureOutput', 'GCS_SERVICE_ACCOUNT': 'AnalyticsGcsServiceAccountOutput', 'S3_ROLE_BASED': 'AnalyticsS3RoleBasedOutput'}
- property openapi_types
bitmovin_api_sdk.models.analytics_output_type module
bitmovin_api_sdk.models.analytics_percentile_query_request module
- class bitmovin_api_sdk.models.analytics_percentile_query_request.AnalyticsPercentileQueryRequest(**kwargs)[source]
Bases:
AnalyticsQueryRequest- property attribute_map
- property openapi_types
- property percentile
Gets the percentile of this AnalyticsPercentileQueryRequest.
The percentage (0-99) used for percentile queries. (required)
- Returns
The percentile of this AnalyticsPercentileQueryRequest.
- Return type
int
bitmovin_api_sdk.models.analytics_query_operator module
bitmovin_api_sdk.models.analytics_query_request module
- class bitmovin_api_sdk.models.analytics_query_request.AnalyticsQueryRequest(**kwargs)[source]
Bases:
AnalyticsQueryTimeframe- property attribute_map
- property dimension
Gets the dimension of this AnalyticsQueryRequest.
- Returns
The dimension of this AnalyticsQueryRequest.
- Return type
- property filters
Gets the filters of this AnalyticsQueryRequest.
Analytics Query Filters Each filter requires 3 properties: name, operator and value. Valid operators are [IN, EQ, NE, LT, LTE, GT, GTE, CONTAINS, NOTCONTAINS]
- Returns
The filters of this AnalyticsQueryRequest.
- Return type
list[AnalyticsAbstractFilter]
- property group_by
Gets the group_by of this AnalyticsQueryRequest.
- Returns
The group_by of this AnalyticsQueryRequest.
- Return type
list[AnalyticsAttribute]
- property include_context
Gets the include_context of this AnalyticsQueryRequest.
Whether context data should be included in the response
- Returns
The include_context of this AnalyticsQueryRequest.
- Return type
bool
- property interval
Gets the interval of this AnalyticsQueryRequest.
- Returns
The interval of this AnalyticsQueryRequest.
- Return type
- property license_key
Gets the license_key of this AnalyticsQueryRequest.
Analytics license key (required)
- Returns
The license_key of this AnalyticsQueryRequest.
- Return type
string_types
- property limit
Gets the limit of this AnalyticsQueryRequest.
Maximum number of rows returned (max. 200)
- Returns
The limit of this AnalyticsQueryRequest.
- Return type
int
- property offset
Gets the offset of this AnalyticsQueryRequest.
Offset of data
- Returns
The offset of this AnalyticsQueryRequest.
- Return type
int
- property openapi_types
- property order_by
Gets the order_by of this AnalyticsQueryRequest.
- Returns
The order_by of this AnalyticsQueryRequest.
- Return type
list[AnalyticsOrderByEntry]
bitmovin_api_sdk.models.analytics_query_timeframe module
- class bitmovin_api_sdk.models.analytics_query_timeframe.AnalyticsQueryTimeframe(**kwargs)[source]
Bases:
object- property attribute_map
- property end
Gets the end of this AnalyticsQueryTimeframe.
End of timeframe which is queried in UTC format.
- Returns
The end of this AnalyticsQueryTimeframe.
- Return type
datetime
- property openapi_types
- property start
Gets the start of this AnalyticsQueryTimeframe.
Start of timeframe which is queried in UTC format.
- Returns
The start of this AnalyticsQueryTimeframe.
- Return type
datetime
bitmovin_api_sdk.models.analytics_response module
- class bitmovin_api_sdk.models.analytics_response.AnalyticsResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property column_labels
Gets the column_labels of this AnalyticsResponse.
- Returns
The column_labels of this AnalyticsResponse.
- Return type
list[AnalyticsColumnLabel]
- property context_description
Gets the context_description of this AnalyticsResponse.
- Returns
The context_description of this AnalyticsResponse.
- Return type
- property openapi_types
- property row_count
Gets the row_count of this AnalyticsResponse.
Number of rows returned
- Returns
The row_count of this AnalyticsResponse.
- Return type
int
- property rows
Gets the rows of this AnalyticsResponse.
- Returns
The rows of this AnalyticsResponse.
- Return type
list[object]
bitmovin_api_sdk.models.analytics_s3_role_based_output module
- class bitmovin_api_sdk.models.analytics_s3_role_based_output.AnalyticsS3RoleBasedOutput(**kwargs)[source]
Bases:
AnalyticsOutput- property attribute_map
- property bucket_name
Gets the bucket_name of this AnalyticsS3RoleBasedOutput.
Amazon S3 bucket name (required)
- Returns
The bucket_name of this AnalyticsS3RoleBasedOutput.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this AnalyticsS3RoleBasedOutput.
- Returns
The cloud_region of this AnalyticsS3RoleBasedOutput.
- Return type
- property external_id
Gets the external_id of this AnalyticsS3RoleBasedOutput.
External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won’t be able to write to the S3 bucket. An appropriate trust policy would look like this:
` { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "{{externalId}}" } } } `where “{{externalId}}” is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the output configuration Bitmovin won’t be able to write to the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won’t be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new output, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html- Returns
The external_id of this AnalyticsS3RoleBasedOutput.
- Return type
string_types
- property external_id_mode
Gets the external_id_mode of this AnalyticsS3RoleBasedOutput.
- Returns
The external_id_mode of this AnalyticsS3RoleBasedOutput.
- Return type
- property md5_meta_tag
Gets the md5_meta_tag of this AnalyticsS3RoleBasedOutput.
If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.
- Returns
The md5_meta_tag of this AnalyticsS3RoleBasedOutput.
- Return type
string_types
- property openapi_types
- property role_arn
Gets the role_arn of this AnalyticsS3RoleBasedOutput.
Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role:
` { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "{{externalId}}" } } } `where “arn:aws:iam::630681592166:user/bitmovinCustomerS3Access” is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to write data to your S3 bucket. Please note that the IAM role has to have write access to S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)- Returns
The role_arn of this AnalyticsS3RoleBasedOutput.
- Return type
string_types
- property signature_version
Gets the signature_version of this AnalyticsS3RoleBasedOutput.
Specifies the method used for authentication
- Returns
The signature_version of this AnalyticsS3RoleBasedOutput.
- Return type
bitmovin_api_sdk.models.analytics_stddev_query_request module
bitmovin_api_sdk.models.analytics_sum_query_request module
bitmovin_api_sdk.models.analytics_variance_query_request module
bitmovin_api_sdk.models.analytics_virtual_license module
- class bitmovin_api_sdk.models.analytics_virtual_license.AnalyticsVirtualLicense(**kwargs)[source]
Bases:
object- property attribute_map
- property compressed_retention_time
Gets the compressed_retention_time of this AnalyticsVirtualLicense.
Retention time for compressed data, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S
- Returns
The compressed_retention_time of this AnalyticsVirtualLicense.
- Return type
string_types
- property custom_data_field_labels
Gets the custom_data_field_labels of this AnalyticsVirtualLicense.
Labels for Custom Data fields
- Returns
The custom_data_field_labels of this AnalyticsVirtualLicense.
- Return type
- property custom_data_fields_count
Gets the custom_data_fields_count of this AnalyticsVirtualLicense.
The number of customData fields available
- Returns
The custom_data_fields_count of this AnalyticsVirtualLicense.
- Return type
int
- property id
Gets the id of this AnalyticsVirtualLicense.
Analytics Virtual License Key/Id
- Returns
The id of this AnalyticsVirtualLicense.
- Return type
string_types
- property licenses
Gets the licenses of this AnalyticsVirtualLicense.
List of Analytics Licenses
- Returns
The licenses of this AnalyticsVirtualLicense.
- Return type
- property name
Gets the name of this AnalyticsVirtualLicense.
Name of the Analytics Virtual License
- Returns
The name of this AnalyticsVirtualLicense.
- Return type
string_types
- property openapi_types
- property plan_expired_at
Gets the plan_expired_at of this AnalyticsVirtualLicense.
The expiration date of the license if applicable, returned as ISO 8601 date-time format
- Returns
The plan_expired_at of this AnalyticsVirtualLicense.
- Return type
datetime
- property retention_time
Gets the retention_time of this AnalyticsVirtualLicense.
Retention time of impressions, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S
- Returns
The retention_time of this AnalyticsVirtualLicense.
- Return type
string_types
- property timezone
Gets the timezone of this AnalyticsVirtualLicense.
The timezone of the Analytics Virtual License
- Returns
The timezone of this AnalyticsVirtualLicense.
- Return type
string_types
bitmovin_api_sdk.models.analytics_virtual_license_licenses_list_item module
- class bitmovin_api_sdk.models.analytics_virtual_license_licenses_list_item.AnalyticsVirtualLicenseLicensesListItem(**kwargs)[source]
Bases:
object- property attribute_map
- property id
Gets the id of this AnalyticsVirtualLicenseLicensesListItem.
Analytics License Id
- Returns
The id of this AnalyticsVirtualLicenseLicensesListItem.
- Return type
string_types
- property license_key
Gets the license_key of this AnalyticsVirtualLicenseLicensesListItem.
Analytics License key
- Returns
The license_key of this AnalyticsVirtualLicenseLicensesListItem.
- Return type
string_types
- property name
Gets the name of this AnalyticsVirtualLicenseLicensesListItem.
Analytics License name
- Returns
The name of this AnalyticsVirtualLicenseLicensesListItem.
- Return type
string_types
- property openapi_types
- property org_id
Gets the org_id of this AnalyticsVirtualLicenseLicensesListItem.
Organisation Id of license
- Returns
The org_id of this AnalyticsVirtualLicenseLicensesListItem.
- Return type
string_types
bitmovin_api_sdk.models.analytics_virtual_license_request module
- class bitmovin_api_sdk.models.analytics_virtual_license_request.AnalyticsVirtualLicenseRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property custom_data_field_labels
Gets the custom_data_field_labels of this AnalyticsVirtualLicenseRequest.
Labels for Custom Data fields
- Returns
The custom_data_field_labels of this AnalyticsVirtualLicenseRequest.
- Return type
- property licenses
Gets the licenses of this AnalyticsVirtualLicenseRequest.
List of Analytics Licenses (required)
- Returns
The licenses of this AnalyticsVirtualLicenseRequest.
- Return type
- property name
Gets the name of this AnalyticsVirtualLicenseRequest.
Name of the Analytics Virtual License (required)
- Returns
The name of this AnalyticsVirtualLicenseRequest.
- Return type
string_types
- property openapi_types
- property timezone
Gets the timezone of this AnalyticsVirtualLicenseRequest.
The timezone of the Analytics Virtual License (required)
- Returns
The timezone of this AnalyticsVirtualLicenseRequest.
- Return type
string_types
bitmovin_api_sdk.models.and_conjunction module
bitmovin_api_sdk.models.api_error_definition module
- class bitmovin_api_sdk.models.api_error_definition.ApiErrorDefinition(**kwargs)[source]
Bases:
object- property attribute_map
- property category
Gets the category of this ApiErrorDefinition.
The error category.
- Returns
The category of this ApiErrorDefinition.
- Return type
string_types
- property code
Gets the code of this ApiErrorDefinition.
The error code.
- Returns
The code of this ApiErrorDefinition.
- Return type
int
- property description
Gets the description of this ApiErrorDefinition.
The returned error description.
- Returns
The description of this ApiErrorDefinition.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.applied_stream_settings module
- class bitmovin_api_sdk.models.applied_stream_settings.AppliedStreamSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property height
Gets the height of this AppliedStreamSettings.
The applied height. Useful if the height in the configuration was undefined
- Returns
The height of this AppliedStreamSettings.
- Return type
int
- property openapi_types
- property width
Gets the width of this AppliedStreamSettings.
The applied width. Useful if the width in the configuration was undefined
- Returns
The width of this AppliedStreamSettings.
- Return type
int
bitmovin_api_sdk.models.aspect_mode module
bitmovin_api_sdk.models.aspera_input module
- class bitmovin_api_sdk.models.aspera_input.AsperaInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property fasp_port
Gets the fasp_port of this AsperaInput.
Set the UDP port to be used by fasp for data transfer
- Returns
The fasp_port of this AsperaInput.
- Return type
int
- property host
Gets the host of this AsperaInput.
Host to use for Aspera transfers (required)
- Returns
The host of this AsperaInput.
- Return type
string_types
- property max_bandwidth
Gets the max_bandwidth of this AsperaInput.
Maximal download bandwidth. Examples: 100k, 100m, 100g
- Returns
The max_bandwidth of this AsperaInput.
- Return type
string_types
- property min_bandwidth
Gets the min_bandwidth of this AsperaInput.
Minimal download bandwidth. Examples: 100k, 100m, 100g
- Returns
The min_bandwidth of this AsperaInput.
- Return type
string_types
- property openapi_types
- property password
Gets the password of this AsperaInput.
corresponding password (either password and user must be set or token)
- Returns
The password of this AsperaInput.
- Return type
string_types
- property ssh_port
Gets the ssh_port of this AsperaInput.
Set the TCP port to be used for fasp session initiation
- Returns
The ssh_port of this AsperaInput.
- Return type
int
- property token
Gets the token of this AsperaInput.
Token used for authentication (either password and user must be set or token)
- Returns
The token of this AsperaInput.
- Return type
string_types
- property username
Gets the username of this AsperaInput.
Username to log into Aspera host (either password and user must be set or token)
- Returns
The username of this AsperaInput.
- Return type
string_types
bitmovin_api_sdk.models.audio_adaptation_set module
- class bitmovin_api_sdk.models.audio_adaptation_set.AudioAdaptationSet(**kwargs)[source]
Bases:
AdaptationSet- property attribute_map
- property lang
Gets the lang of this AudioAdaptationSet.
ISO 639-1 (Alpha-2) code identifying the language of the audio adaptation set (required)
- Returns
The lang of this AudioAdaptationSet.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.audio_configuration module
- class bitmovin_api_sdk.models.audio_configuration.AudioConfiguration(**kwargs)[source]
Bases:
CodecConfiguration- property attribute_map
- property bitrate
Gets the bitrate of this AudioConfiguration.
Target bitrate for the encoded audio in bps (required)
- Returns
The bitrate of this AudioConfiguration.
- Return type
int
- property openapi_types
- property rate
Gets the rate of this AudioConfiguration.
Audio sampling rate in Hz
- Returns
The rate of this AudioConfiguration.
- Return type
float
bitmovin_api_sdk.models.audio_group module
- class bitmovin_api_sdk.models.audio_group.AudioGroup(**kwargs)[source]
Bases:
object- property attribute_map
- property name
Gets the name of this AudioGroup.
Name of the audio group (required)
- Returns
The name of this AudioGroup.
- Return type
string_types
- property openapi_types
- property priority
Gets the priority of this AudioGroup.
Priority of the audio group (required)
- Returns
The priority of this AudioGroup.
- Return type
int
bitmovin_api_sdk.models.audio_group_configuration module
- class bitmovin_api_sdk.models.audio_group_configuration.AudioGroupConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property dropping_mode
Gets the dropping_mode of this AudioGroupConfiguration.
Dropping mode (required)
- Returns
The dropping_mode of this AudioGroupConfiguration.
- Return type
- property groups
Gets the groups of this AudioGroupConfiguration.
Audio groups (required)
- Returns
The groups of this AudioGroupConfiguration.
- Return type
list[AudioGroup]
- property openapi_types
bitmovin_api_sdk.models.audio_media_info module
- class bitmovin_api_sdk.models.audio_media_info.AudioMediaInfo(**kwargs)[source]
Bases:
StandardMediaInfo- property attribute_map
- property forced
Gets the forced of this AudioMediaInfo.
A value of true indicates that the Rendition contains content which is considered essential to play.
- Returns
The forced of this AudioMediaInfo.
- Return type
bool
- property openapi_types
bitmovin_api_sdk.models.audio_mix_channel module
- class bitmovin_api_sdk.models.audio_mix_channel.AudioMixChannel(**kwargs)[source]
Bases:
object- property attribute_map
- property channel_number
Gets the channel_number of this AudioMixChannel.
Channel number of this mix (starting with 0) (required)
- Returns
The channel_number of this AudioMixChannel.
- Return type
int
- property openapi_types
- property source_channels
Gets the source_channels of this AudioMixChannel.
List of source channels to be mixed (required)
- Returns
The source_channels of this AudioMixChannel.
- Return type
list[SourceChannel]
bitmovin_api_sdk.models.audio_mix_channel_layout module
- class bitmovin_api_sdk.models.audio_mix_channel_layout.AudioMixChannelLayout(value)[source]
Bases:
EnumAn enumeration.
- CL_2_1 = '2.1'
- CL_2_2 = '2.2'
- CL_3_1 = '3.1'
- CL_4_0 = '4.0'
- CL_4_1 = '4.1'
- CL_5_0 = '5.0'
- CL_5_0_BACK = '5.0_BACK'
- CL_5_1 = '5.1'
- CL_5_1_BACK = '5.1_BACK'
- CL_6_0 = '6.0'
- CL_6_0_FRONT = '6.0_FRONT'
- CL_6_1 = '6.1'
- CL_6_1_BACK = '6.1_BACK'
- CL_6_1_FRONT = '6.1_FRONT'
- CL_7_0 = '7.0'
- CL_7_0_FRONT = '7.0_FRONT'
- CL_7_1 = '7.1'
- CL_7_1_WIDE = '7.1_WIDE'
- CL_7_1_WIDE_BACK = '7.1_WIDE_BACK'
- CL_HEXAGONAL = 'HEXAGONAL'
- CL_MONO = 'MONO'
- CL_OCTAGONAL = 'OCTAGONAL'
- CL_QUAD = 'QUAD'
- CL_STEREO = 'STEREO'
- CL_STEREO_DOWNMIX = 'STEREO_DOWNMIX'
- CL_SURROUND = 'SURROUND'
- NONE = 'NONE'
bitmovin_api_sdk.models.audio_mix_channel_type module
- class bitmovin_api_sdk.models.audio_mix_channel_type.AudioMixChannelType(value)[source]
Bases:
EnumAn enumeration.
- BACK_LEFT = 'BACK_LEFT'
- BACK_RIGHT = 'BACK_RIGHT'
- CENTER = 'CENTER'
- CHANNEL_NUMBER = 'CHANNEL_NUMBER'
- FRONT_LEFT = 'FRONT_LEFT'
- FRONT_RIGHT = 'FRONT_RIGHT'
- LOW_FREQUENCY = 'LOW_FREQUENCY'
- SURROUND_LEFT = 'SURROUND_LEFT'
- SURROUND_RIGHT = 'SURROUND_RIGHT'
bitmovin_api_sdk.models.audio_mix_filter module
- class bitmovin_api_sdk.models.audio_mix_filter.AudioMixFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property audio_mix_channels
Gets the audio_mix_channels of this AudioMixFilter.
List of mixed channels that matches the channel layout (required)
- Returns
The audio_mix_channels of this AudioMixFilter.
- Return type
list[AudioMixChannel]
- property channel_layout
Gets the channel_layout of this AudioMixFilter.
Channel layout of the audio codec configuration (required)
- Returns
The channel_layout of this AudioMixFilter.
- Return type
- property openapi_types
bitmovin_api_sdk.models.audio_mix_input_channel_layout module
- class bitmovin_api_sdk.models.audio_mix_input_channel_layout.AudioMixInputChannelLayout(value)[source]
Bases:
EnumAn enumeration.
- CL_2_1 = '2.1'
- CL_2_2 = '2.2'
- CL_3_1 = '3.1'
- CL_4_0 = '4.0'
- CL_4_1 = '4.1'
- CL_5_0 = '5.0'
- CL_5_0_BACK = '5.0_BACK'
- CL_5_1 = '5.1'
- CL_5_1_BACK = '5.1_BACK'
- CL_6_0 = '6.0'
- CL_6_0_FRONT = '6.0_FRONT'
- CL_6_1 = '6.1'
- CL_6_1_BACK = '6.1_BACK'
- CL_6_1_FRONT = '6.1_FRONT'
- CL_7_0 = '7.0'
- CL_7_0_FRONT = '7.0_FRONT'
- CL_7_1 = '7.1'
- CL_7_1_WIDE = '7.1_WIDE'
- CL_7_1_WIDE_BACK = '7.1_WIDE_BACK'
- CL_HEXAGONAL = 'HEXAGONAL'
- CL_OCTAGONAL = 'OCTAGONAL'
- CL_QUAD = 'QUAD'
- CL_STEREO = 'STEREO'
- CL_STEREO_DOWNMIX = 'STEREO_DOWNMIX'
- CL_SURROUND = 'SURROUND'
- MONO = 'MONO'
- NONE = 'NONE'
bitmovin_api_sdk.models.audio_mix_input_stream module
- class bitmovin_api_sdk.models.audio_mix_input_stream.AudioMixInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property audio_mix_channels
Gets the audio_mix_channels of this AudioMixInputStream.
- Returns
The audio_mix_channels of this AudioMixInputStream.
- Return type
- property channel_layout
Gets the channel_layout of this AudioMixInputStream.
Channel layout of the audio mix input stream
- Returns
The channel_layout of this AudioMixInputStream.
- Return type
- property openapi_types
bitmovin_api_sdk.models.audio_mix_input_stream_channel module
- class bitmovin_api_sdk.models.audio_mix_input_stream_channel.AudioMixInputStreamChannel(**kwargs)[source]
Bases:
object- property attribute_map
- property input_stream_id
Gets the input_stream_id of this AudioMixInputStreamChannel.
The id of the input stream that should be used for mixing.
- Returns
The input_stream_id of this AudioMixInputStreamChannel.
- Return type
string_types
- property openapi_types
- property output_channel_number
Gets the output_channel_number of this AudioMixInputStreamChannel.
Number of this output channel. If type is ‘CHANNEL_NUMBER’, this must be set.
- Returns
The output_channel_number of this AudioMixInputStreamChannel.
- Return type
int
- property output_channel_type
Gets the output_channel_type of this AudioMixInputStreamChannel.
- Returns
The output_channel_type of this AudioMixInputStreamChannel.
- Return type
- property source_channels
Gets the source_channels of this AudioMixInputStreamChannel.
List of source channels to be mixed
- Returns
The source_channels of this AudioMixInputStreamChannel.
- Return type
bitmovin_api_sdk.models.audio_mix_input_stream_source_channel module
- class bitmovin_api_sdk.models.audio_mix_input_stream_source_channel.AudioMixInputStreamSourceChannel(**kwargs)[source]
Bases:
object- property attribute_map
- property channel_number
Gets the channel_number of this AudioMixInputStreamSourceChannel.
Number of this source channel. If type is ‘CHANNEL_NUMBER’, this must be set.
- Returns
The channel_number of this AudioMixInputStreamSourceChannel.
- Return type
int
- property gain
Gets the gain of this AudioMixInputStreamSourceChannel.
Gain for this source channel. Default is 1.0.
- Returns
The gain of this AudioMixInputStreamSourceChannel.
- Return type
float
- property openapi_types
- property type
Gets the type of this AudioMixInputStreamSourceChannel.
- Returns
The type of this AudioMixInputStreamSourceChannel.
- Return type
bitmovin_api_sdk.models.audio_mix_source_channel_type module
- class bitmovin_api_sdk.models.audio_mix_source_channel_type.AudioMixSourceChannelType(value)[source]
Bases:
EnumAn enumeration.
- BACK_LEFT = 'BACK_LEFT'
- BACK_RIGHT = 'BACK_RIGHT'
- CENTER = 'CENTER'
- CHANNEL_NUMBER = 'CHANNEL_NUMBER'
- FRONT_LEFT = 'FRONT_LEFT'
- FRONT_RIGHT = 'FRONT_RIGHT'
- LOW_FREQUENCY = 'LOW_FREQUENCY'
- SURROUND_LEFT = 'SURROUND_LEFT'
- SURROUND_RIGHT = 'SURROUND_RIGHT'
bitmovin_api_sdk.models.audio_stream module
- class bitmovin_api_sdk.models.audio_stream.AudioStream(**kwargs)[source]
Bases:
MediaStream- property attribute_map
- property bitrate
Gets the bitrate of this AudioStream.
Bitrate in bps
- Returns
The bitrate of this AudioStream.
- Return type
string_types
- property channel_format
Gets the channel_format of this AudioStream.
Audio channel format
- Returns
The channel_format of this AudioStream.
- Return type
string_types
- property hearing_impaired
Gets the hearing_impaired of this AudioStream.
Hearing impaired support
- Returns
The hearing_impaired of this AudioStream.
- Return type
bool
- property language
Gets the language of this AudioStream.
Language of the stream
- Returns
The language of this AudioStream.
- Return type
string_types
- property openapi_types
- property rate
Gets the rate of this AudioStream.
Bitrate in bps
- Returns
The rate of this AudioStream.
- Return type
int
- property sample_rate
Gets the sample_rate of this AudioStream.
Audio sampling rate in Hz
- Returns
The sample_rate of this AudioStream.
- Return type
int
bitmovin_api_sdk.models.audio_video_sync_mode module
bitmovin_api_sdk.models.audio_volume_filter module
- class bitmovin_api_sdk.models.audio_volume_filter.AudioVolumeFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property format
Gets the format of this AudioVolumeFilter.
- Returns
The format of this AudioVolumeFilter.
- Return type
- property openapi_types
- property unit
Gets the unit of this AudioVolumeFilter.
- Returns
The unit of this AudioVolumeFilter.
- Return type
- property volume
Gets the volume of this AudioVolumeFilter.
Audio volume value (required)
- Returns
The volume of this AudioVolumeFilter.
- Return type
float
bitmovin_api_sdk.models.audio_volume_format module
bitmovin_api_sdk.models.audio_volume_unit module
bitmovin_api_sdk.models.auto_level_setup module
bitmovin_api_sdk.models.auto_representation module
- class bitmovin_api_sdk.models.auto_representation.AutoRepresentation(**kwargs)[source]
Bases:
object- property adopt_configuration_threshold
Gets the adopt_configuration_threshold of this AutoRepresentation.
This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.
- Returns
The adopt_configuration_threshold of this AutoRepresentation.
- Return type
float
- property attribute_map
- property openapi_types
bitmovin_api_sdk.models.auto_restart_configuration module
- class bitmovin_api_sdk.models.auto_restart_configuration.AutoRestartConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property bytes_written_timeout
Gets the bytes_written_timeout of this AutoRestartConfiguration.
If no data was written for the given number of seconds, a restart is triggered. Minimum: 30.0
- Returns
The bytes_written_timeout of this AutoRestartConfiguration.
- Return type
float
- property dash_manifests_update_timeout
Gets the dash_manifests_update_timeout of this AutoRestartConfiguration.
If DASH manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0
- Returns
The dash_manifests_update_timeout of this AutoRestartConfiguration.
- Return type
float
- property frames_written_timeout
Gets the frames_written_timeout of this AutoRestartConfiguration.
If no frames were generated for the given number of seconds, a restart is triggered. Minimum: 30.0
- Returns
The frames_written_timeout of this AutoRestartConfiguration.
- Return type
float
- property hls_manifests_update_timeout
Gets the hls_manifests_update_timeout of this AutoRestartConfiguration.
If HLS manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0
- Returns
The hls_manifests_update_timeout of this AutoRestartConfiguration.
- Return type
float
- property openapi_types
- property restart_on_encoder_error
Gets the restart_on_encoder_error of this AutoRestartConfiguration.
Defines if the encoding should be restarted in case of an error during encoding.
- Returns
The restart_on_encoder_error of this AutoRestartConfiguration.
- Return type
bool
- property schedule_expression
Gets the schedule_expression of this AutoRestartConfiguration.
Defines a schedule for restarts using the unix crontab syntax. This example would trigger a restart every monday at 05:30 (AM)
- Returns
The schedule_expression of this AutoRestartConfiguration.
- Return type
string_types
- property segments_written_timeout
Gets the segments_written_timeout of this AutoRestartConfiguration.
If no segments were generated for the given number of seconds, a restart is triggered. Minimum: 30.0
- Returns
The segments_written_timeout of this AutoRestartConfiguration.
- Return type
float
bitmovin_api_sdk.models.av1_per_title_configuration module
bitmovin_api_sdk.models.av1_preset_configuration module
bitmovin_api_sdk.models.av1_video_configuration module
- class bitmovin_api_sdk.models.av1_video_configuration.Av1VideoConfiguration(**kwargs)[source]
Bases:
VideoConfiguration- property attribute_map
- property auto_level_setup
Gets the auto_level_setup of this Av1VideoConfiguration.
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.
- Returns
The auto_level_setup of this Av1VideoConfiguration.
- Return type
- property openapi_types
- property preset_configuration
Gets the preset_configuration of this Av1VideoConfiguration.
Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.
- Returns
The preset_configuration of this Av1VideoConfiguration.
- Return type
bitmovin_api_sdk.models.availability_start_time_mode module
bitmovin_api_sdk.models.aws_account module
- class bitmovin_api_sdk.models.aws_account.AwsAccount(**kwargs)[source]
Bases:
BitmovinResource- property access_key
Gets the access_key of this AwsAccount.
Amazon access key (required)
- Returns
The access_key of this AwsAccount.
- Return type
string_types
- property account_number
Gets the account_number of this AwsAccount.
Amazon account number (12 digits as per AWS spec) (required)
- Returns
The account_number of this AwsAccount.
- Return type
string_types
- property attribute_map
- property openapi_types
- property secret_key
Gets the secret_key of this AwsAccount.
Amazon secret key (required)
- Returns
The secret_key of this AwsAccount.
- Return type
string_types
bitmovin_api_sdk.models.aws_account_region_settings module
- class bitmovin_api_sdk.models.aws_account_region_settings.AwsAccountRegionSettings(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property limit_parallel_encodings
Gets the limit_parallel_encodings of this AwsAccountRegionSettings.
Limit for the amount of running encodings at a time. Leave empty for no limit.
- Returns
The limit_parallel_encodings of this AwsAccountRegionSettings.
- Return type
int
- property openapi_types
- property region
Gets the region of this AwsAccountRegionSettings.
- Returns
The region of this AwsAccountRegionSettings.
- Return type
- property security_group_id
Gets the security_group_id of this AwsAccountRegionSettings.
Id of the security group for encoding instances (required)
- Returns
The security_group_id of this AwsAccountRegionSettings.
- Return type
string_types
- property ssh_port
Gets the ssh_port of this AwsAccountRegionSettings.
Custom SSH port. Valid values: 1 - 65535. Leave empty if the default SSH port 22 is OK.
- Returns
The ssh_port of this AwsAccountRegionSettings.
- Return type
int
- property subnet_id
Gets the subnet_id of this AwsAccountRegionSettings.
Id of the subnet for encoding instances (required)
- Returns
The subnet_id of this AwsAccountRegionSettings.
- Return type
string_types
bitmovin_api_sdk.models.aws_cloud_region module
- class bitmovin_api_sdk.models.aws_cloud_region.AwsCloudRegion(value)[source]
Bases:
EnumAn enumeration.
- AP_NORTHEAST_1 = 'AP_NORTHEAST_1'
- AP_NORTHEAST_2 = 'AP_NORTHEAST_2'
- AP_SOUTHEAST_1 = 'AP_SOUTHEAST_1'
- AP_SOUTHEAST_2 = 'AP_SOUTHEAST_2'
- AP_SOUTH_1 = 'AP_SOUTH_1'
- CA_CENTRAL_1 = 'CA_CENTRAL_1'
- EU_CENTRAL_1 = 'EU_CENTRAL_1'
- EU_NORTH_1 = 'EU_NORTH_1'
- EU_WEST_1 = 'EU_WEST_1'
- EU_WEST_2 = 'EU_WEST_2'
- EU_WEST_3 = 'EU_WEST_3'
- SA_EAST_1 = 'SA_EAST_1'
- US_EAST_1 = 'US_EAST_1'
- US_EAST_2 = 'US_EAST_2'
- US_WEST_1 = 'US_WEST_1'
- US_WEST_2 = 'US_WEST_2'
bitmovin_api_sdk.models.azure_account module
- class bitmovin_api_sdk.models.azure_account.AzureAccount(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property openapi_types
- property resource_group_id
Gets the resource_group_id of this AzureAccount.
The name of the resource group where you intend to run the Encoding VMs (required)
- Returns
The resource_group_id of this AzureAccount.
- Return type
string_types
- property subscription_id
Gets the subscription_id of this AzureAccount.
Your Azure Subscription ID (The ID of your subscription where you intend to run the Encoding VMs) (required)
- Returns
The subscription_id of this AzureAccount.
- Return type
string_types
- property tenant_id
Gets the tenant_id of this AzureAccount.
The ID of your Active Directory where your subscription runs in (required)
- Returns
The tenant_id of this AzureAccount.
- Return type
string_types
bitmovin_api_sdk.models.azure_account_region_settings module
- class bitmovin_api_sdk.models.azure_account_region_settings.AzureAccountRegionSettings(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property network_name
Gets the network_name of this AzureAccountRegionSettings.
Name of the virtual network (required)
- Returns
The network_name of this AzureAccountRegionSettings.
- Return type
string_types
- property openapi_types
- property region
Gets the region of this AzureAccountRegionSettings.
- Returns
The region of this AzureAccountRegionSettings.
- Return type
- property subnet_name
Gets the subnet_name of this AzureAccountRegionSettings.
Name of the subnet (required)
- Returns
The subnet_name of this AzureAccountRegionSettings.
- Return type
string_types
bitmovin_api_sdk.models.azure_cloud_region module
- class bitmovin_api_sdk.models.azure_cloud_region.AzureCloudRegion(value)[source]
Bases:
EnumAn enumeration.
- ASIA_EAST = 'ASIA_EAST'
- ASIA_SOUTHEAST = 'ASIA_SOUTHEAST'
- AUSTRALIA_EAST = 'AUSTRALIA_EAST'
- AUSTRALIA_SOUTHEAST = 'AUSTRALIA_SOUTHEAST'
- BRAZIL_SOUTH = 'BRAZIL_SOUTH'
- CANADA_CENTRAL = 'CANADA_CENTRAL'
- EUROPE_NORTH = 'EUROPE_NORTH'
- EUROPE_WEST = 'EUROPE_WEST'
- FRANCE_CENTRAL = 'FRANCE_CENTRAL'
- GERMANY_WESTCENTRAL = 'GERMANY_WESTCENTRAL'
- INDIA_CENTRAL = 'INDIA_CENTRAL'
- INDIA_SOUTH = 'INDIA_SOUTH'
- JAPAN_EAST = 'JAPAN_EAST'
- JAPAN_WEST = 'JAPAN_WEST'
- KOREA_CENTRAL = 'KOREA_CENTRAL'
- UAE_NORTH = 'UAE_NORTH'
- UK_SOUTH = 'UK_SOUTH'
- US_CENTRAL = 'US_CENTRAL'
- US_EAST = 'US_EAST'
- US_EAST2 = 'US_EAST2'
- US_NORTH_CENTRAL = 'US_NORTH_CENTRAL'
- US_SOUTH_CENTRAL = 'US_SOUTH_CENTRAL'
- US_WEST = 'US_WEST'
- US_WEST2 = 'US_WEST2'
bitmovin_api_sdk.models.azure_input module
- class bitmovin_api_sdk.models.azure_input.AzureInput(**kwargs)[source]
Bases:
Input- property account_key
Gets the account_key of this AzureInput.
Azure Account Key (required)
- Returns
The account_key of this AzureInput.
- Return type
string_types
- property account_name
Gets the account_name of this AzureInput.
Azure Account Name (required)
- Returns
The account_name of this AzureInput.
- Return type
string_types
- property attribute_map
- property container
Gets the container of this AzureInput.
Name of the bucket (required)
- Returns
The container of this AzureInput.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.azure_output module
- class bitmovin_api_sdk.models.azure_output.AzureOutput(**kwargs)[source]
Bases:
Output- property account_key
Gets the account_key of this AzureOutput.
Azure Account Key (required)
- Returns
The account_key of this AzureOutput.
- Return type
string_types
- property account_name
Gets the account_name of this AzureOutput.
Azure Account Name (required)
- Returns
The account_name of this AzureOutput.
- Return type
string_types
- property attribute_map
- property container
Gets the container of this AzureOutput.
Name of the bucket (required)
- Returns
The container of this AzureOutput.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.azure_speech_services_credentials module
- class bitmovin_api_sdk.models.azure_speech_services_credentials.AzureSpeechServicesCredentials(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property subscription_key
Gets the subscription_key of this AzureSpeechServicesCredentials.
Azure Speech Services resource key (required)
- Returns
The subscription_key of this AzureSpeechServicesCredentials.
- Return type
string_types
bitmovin_api_sdk.models.azure_speech_to_captions_filter module
- class bitmovin_api_sdk.models.azure_speech_to_captions_filter.AzureSpeechToCaptionsFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property azure_speech_to_captions_settings
Gets the azure_speech_to_captions_settings of this AzureSpeechToCaptionsFilter.
- Returns
The azure_speech_to_captions_settings of this AzureSpeechToCaptionsFilter.
- Return type
- property openapi_types
bitmovin_api_sdk.models.azure_speech_to_captions_profanity module
bitmovin_api_sdk.models.azure_speech_to_captions_settings module
- class bitmovin_api_sdk.models.azure_speech_to_captions_settings.AzureSpeechToCaptionsSettings(**kwargs)[source]
Bases:
object- property api_endpoint
Gets the api_endpoint of this AzureSpeechToCaptionsSettings.
Azure Speech Services API endpoint. This information can be found in Azure’s Speech resource data.
- Returns
The api_endpoint of this AzureSpeechToCaptionsSettings.
- Return type
string_types
- property attribute_map
- property azure_speech_services_credentials
Gets the azure_speech_services_credentials of this AzureSpeechToCaptionsSettings.
Credential settings to access Azure Speech Services
- Returns
The azure_speech_services_credentials of this AzureSpeechToCaptionsSettings.
- Return type
- property caption_delay
Gets the caption_delay of this AzureSpeechToCaptionsSettings.
How many MILLISECONDS to delay the display of each caption, to mimic a real-time experience. The minimum value is 0.
- Returns
The caption_delay of this AzureSpeechToCaptionsSettings.
- Return type
int
- property caption_lines
Gets the caption_lines of this AzureSpeechToCaptionsSettings.
The number of lines for a caption. The minimum value is 1.
- Returns
The caption_lines of this AzureSpeechToCaptionsSettings.
- Return type
int
- property caption_max_line_length
Gets the caption_max_line_length of this AzureSpeechToCaptionsSettings.
The maximum number of characters per line for a caption. The minimum value is 20.
- Returns
The caption_max_line_length of this AzureSpeechToCaptionsSettings.
- Return type
int
- property caption_remain_time
Gets the caption_remain_time of this AzureSpeechToCaptionsSettings.
How many MILLISECONDS a caption should remain on screen if it is not replaced by another. The minimum value is 0.
- Returns
The caption_remain_time of this AzureSpeechToCaptionsSettings.
- Return type
int
- property language
Gets the language of this AzureSpeechToCaptionsSettings.
Azure Speech to captions supported language (IETF BCP 47 language tag). The list of supported languages can be found at Azure’s official documentation.
- Returns
The language of this AzureSpeechToCaptionsSettings.
- Return type
string_types
- property openapi_types
- property profanity_option
Gets the profanity_option of this AzureSpeechToCaptionsSettings.
The profanity filter options are: - Masked: Replaces letters in profane words with asterisk (*) characters. - Raw: Include the profane words verbatim. - Removed: Removes profane words.
- Returns
The profanity_option of this AzureSpeechToCaptionsSettings.
- Return type
- property region
Gets the region of this AzureSpeechToCaptionsSettings.
Azure Speech Services Region Identifier. The list of speech service supported regions can be found at Azure’s official documentation.
- Returns
The region of this AzureSpeechToCaptionsSettings.
- Return type
string_types
bitmovin_api_sdk.models.b_adapt module
bitmovin_api_sdk.models.backup_srt_inputs module
- class bitmovin_api_sdk.models.backup_srt_inputs.BackupSrtInputs(**kwargs)[source]
Bases:
object- property attribute_map
- property delay_threshold
Gets the delay_threshold of this BackupSrtInputs.
When there is no input signal present for this number of seconds, the encoder will switch to the next input
- Returns
The delay_threshold of this BackupSrtInputs.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.basic_media_info module
- class bitmovin_api_sdk.models.basic_media_info.BasicMediaInfo(**kwargs)[source]
Bases:
BitmovinResponse- property assoc_language
Gets the assoc_language of this BasicMediaInfo.
Identifies a language that is associated with the Rendition.
- Returns
The assoc_language of this BasicMediaInfo.
- Return type
string_types
- property attribute_map
- property autoselect
Gets the autoselect of this BasicMediaInfo.
If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.
- Returns
The autoselect of this BasicMediaInfo.
- Return type
bool
- property characteristics
Gets the characteristics of this BasicMediaInfo.
Contains Uniform Type Identifiers
- Returns
The characteristics of this BasicMediaInfo.
- Return type
list[string_types]
- property group_id
Gets the group_id of this BasicMediaInfo.
The value is a quoted-string which specifies the group to which the Rendition belongs. (required)
- Returns
The group_id of this BasicMediaInfo.
- Return type
string_types
- property is_default
Gets the is_default of this BasicMediaInfo.
If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.
- Returns
The is_default of this BasicMediaInfo.
- Return type
bool
- property language
Gets the language of this BasicMediaInfo.
Primary language in the rendition.
- Returns
The language of this BasicMediaInfo.
- Return type
string_types
- property name
Gets the name of this BasicMediaInfo.
Human readable description of the rendition. (required)
- Returns
The name of this BasicMediaInfo.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.bif module
- class bitmovin_api_sdk.models.bif.Bif(**kwargs)[source]
Bases:
BitmovinResource- property aspect_mode
Gets the aspect_mode of this Bif.
Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.
- Returns
The aspect_mode of this Bif.
- Return type
- property attribute_map
- property distance
Gets the distance of this Bif.
Distance in seconds between a screenshot (required)
- Returns
The distance of this Bif.
- Return type
float
- property filename
Gets the filename of this Bif.
Filename of the Bif image. (required)
- Returns
The filename of this Bif.
- Return type
string_types
- property height
Gets the height of this Bif.
Height of one thumbnail
- Returns
The height of this Bif.
- Return type
int
- property openapi_types
- property outputs
Gets the outputs of this Bif.
- Returns
The outputs of this Bif.
- Return type
list[EncodingOutput]
- property width
Gets the width of this Bif.
Width of one thumbnail. Roku recommends a width of 240 for SD and 320 for HD.
- Returns
The width of this Bif.
- Return type
int
bitmovin_api_sdk.models.billable_encoding_feature_minutes module
- class bitmovin_api_sdk.models.billable_encoding_feature_minutes.BillableEncodingFeatureMinutes(**kwargs)[source]
Bases:
object- property attribute_map
- property billable_minutes
Gets the billable_minutes of this BillableEncodingFeatureMinutes.
The billable minutes related to this feature.
- Returns
The billable_minutes of this BillableEncodingFeatureMinutes.
- Return type
float
- property encoded_minutes
Gets the encoded_minutes of this BillableEncodingFeatureMinutes.
Encoded minutes related to this feature.
- Returns
The encoded_minutes of this BillableEncodingFeatureMinutes.
- Return type
float
- property feature_multiplier
Gets the feature_multiplier of this BillableEncodingFeatureMinutes.
The multiplier used for this feature.
- Returns
The feature_multiplier of this BillableEncodingFeatureMinutes.
- Return type
float
- property feature_type
Gets the feature_type of this BillableEncodingFeatureMinutes.
The name of the feature.
- Returns
The feature_type of this BillableEncodingFeatureMinutes.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.billable_encoding_minutes module
- class bitmovin_api_sdk.models.billable_encoding_minutes.BillableEncodingMinutes(**kwargs)[source]
Bases:
object- property attribute_map
- property billable_minutes
Gets the billable_minutes of this BillableEncodingMinutes.
- Returns
The billable_minutes of this BillableEncodingMinutes.
- Return type
- property codec
Gets the codec of this BillableEncodingMinutes.
- Returns
The codec of this BillableEncodingMinutes.
- Return type
- property encoding_mode
Gets the encoding_mode of this BillableEncodingMinutes.
- Returns
The encoding_mode of this BillableEncodingMinutes.
- Return type
- property enhanced_deinterlace
Gets the enhanced_deinterlace of this BillableEncodingMinutes.
Indicates if an enhanced interlace filter was used.
- Returns
The enhanced_deinterlace of this BillableEncodingMinutes.
- Return type
bool
- property live
Gets the live of this BillableEncodingMinutes.
Indicates if the stream was part of a live encoding.
- Returns
The live of this BillableEncodingMinutes.
- Return type
bool
- property nex_guard_ab_watermarking_type
Gets the nex_guard_ab_watermarking_type of this BillableEncodingMinutes.
- Returns
The nex_guard_ab_watermarking_type of this BillableEncodingMinutes.
- Return type
- property openapi_types
- property per_title_result_stream
Gets the per_title_result_stream of this BillableEncodingMinutes.
- Returns
The per_title_result_stream of this BillableEncodingMinutes.
- Return type
- property pixel_format_bit_depth
Gets the pixel_format_bit_depth of this BillableEncodingMinutes.
- Returns
The pixel_format_bit_depth of this BillableEncodingMinutes.
- Return type
- property preset
Gets the preset of this BillableEncodingMinutes.
Name of the preset configuration used for the codec configuration or “CUSTOM” if any preset values were overridden
- Returns
The preset of this BillableEncodingMinutes.
- Return type
string_types
- property psnr_mode
Gets the psnr_mode of this BillableEncodingMinutes.
- Returns
The psnr_mode of this BillableEncodingMinutes.
- Return type
bitmovin_api_sdk.models.billable_encoding_minutes_details module
- class bitmovin_api_sdk.models.billable_encoding_minutes_details.BillableEncodingMinutesDetails(**kwargs)[source]
Bases:
object- property attribute_map
- property audio
Gets the audio of this BillableEncodingMinutesDetails.
Billable minutes for audio. Available if stream is an audio stream.
- Returns
The audio of this BillableEncodingMinutesDetails.
- Return type
float
- property hd
Gets the hd of this BillableEncodingMinutesDetails.
Billable minutes for HD resolutions.
- Returns
The hd of this BillableEncodingMinutesDetails.
- Return type
float
- property openapi_types
- property sd
Gets the sd of this BillableEncodingMinutesDetails.
Billable minutes for SD resolutions.
- Returns
The sd of this BillableEncodingMinutesDetails.
- Return type
float
- property uhd
Gets the uhd of this BillableEncodingMinutesDetails.
Billable minutes for UHD resolutions.
- Returns
The uhd of this BillableEncodingMinutesDetails.
- Return type
float
- property unknown
Gets the unknown of this BillableEncodingMinutesDetails.
Only set if resolution information is not present.
- Returns
The unknown of this BillableEncodingMinutesDetails.
- Return type
float
bitmovin_api_sdk.models.bitmovin_resource module
- class bitmovin_api_sdk.models.bitmovin_resource.BitmovinResource(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property created_at
Gets the created_at of this BitmovinResource.
Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this BitmovinResource.
- Return type
datetime
- property custom_data
Gets the custom_data of this BitmovinResource.
User-specific meta data. This can hold anything.
- Returns
The custom_data of this BitmovinResource.
- Return type
dict(str, object)
- property description
Gets the description of this BitmovinResource.
Description of the resource. Can be freely chosen by the user.
- Returns
The description of this BitmovinResource.
- Return type
string_types
- property modified_at
Gets the modified_at of this BitmovinResource.
Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The modified_at of this BitmovinResource.
- Return type
datetime
- property name
Gets the name of this BitmovinResource.
Name of the resource. Can be freely chosen by the user.
- Returns
The name of this BitmovinResource.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.bitmovin_response module
bitmovin_api_sdk.models.bitmovin_response_list module
bitmovin_api_sdk.models.bitrate_selection_mode module
bitmovin_api_sdk.models.broadcast_ts_audio_input_stream_configuration module
- class bitmovin_api_sdk.models.broadcast_ts_audio_input_stream_configuration.BroadcastTsAudioInputStreamConfiguration(**kwargs)[source]
Bases:
BroadcastTsInputStreamConfiguration- property attribute_map
- property language
Gets the language of this BroadcastTsAudioInputStreamConfiguration.
Language of the audio stream. Specified according to the ISO 639-2 alpha code for the language descriptor.
- Returns
The language of this BroadcastTsAudioInputStreamConfiguration.
- Return type
string_types
- property openapi_types
- property use_atsc_buffer_model
Gets the use_atsc_buffer_model of this BroadcastTsAudioInputStreamConfiguration.
Use ATSC buffer model for AC-3. If true, use the ATSC version of the T-STD buffer model is used. This parameter applies to AC-3 streams only.
- Returns
The use_atsc_buffer_model of this BroadcastTsAudioInputStreamConfiguration.
- Return type
bool
bitmovin_api_sdk.models.broadcast_ts_input_stream_configuration module
- class bitmovin_api_sdk.models.broadcast_ts_input_stream_configuration.BroadcastTsInputStreamConfiguration(**kwargs)[source]
Bases:
object- property align_pes
Gets the align_pes of this BroadcastTsInputStreamConfiguration.
Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet.
- Returns
The align_pes of this BroadcastTsInputStreamConfiguration.
- Return type
bool
- property attribute_map
- property openapi_types
- property packet_identifier
Gets the packet_identifier of this BroadcastTsInputStreamConfiguration.
An integer value. Packet Identifier (PID) for this stream.
- Returns
The packet_identifier of this BroadcastTsInputStreamConfiguration.
- Return type
int
- property set_rai_on_au
Gets the set_rai_on_au of this BroadcastTsInputStreamConfiguration.
- Returns
The set_rai_on_au of this BroadcastTsInputStreamConfiguration.
- Return type
- property start_with_discontinuity_indicator
Gets the start_with_discontinuity_indicator of this BroadcastTsInputStreamConfiguration.
Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID.
- Returns
The start_with_discontinuity_indicator of this BroadcastTsInputStreamConfiguration.
- Return type
bool
- property stream_id
Gets the stream_id of this BroadcastTsInputStreamConfiguration.
The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.
- Returns
The stream_id of this BroadcastTsInputStreamConfiguration.
- Return type
string_types
bitmovin_api_sdk.models.broadcast_ts_muxing module
- class bitmovin_api_sdk.models.broadcast_ts_muxing.BroadcastTsMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property configuration
Gets the configuration of this BroadcastTsMuxing.
- Returns
The configuration of this BroadcastTsMuxing.
- Return type
- property filename
Gets the filename of this BroadcastTsMuxing.
Name of the output file
- Returns
The filename of this BroadcastTsMuxing.
- Return type
string_types
- property openapi_types
- property segment_length
Gets the segment_length of this BroadcastTsMuxing.
Length of the segments in seconds.
- Returns
The segment_length of this BroadcastTsMuxing.
- Return type
float
bitmovin_api_sdk.models.broadcast_ts_muxing_configuration module
- class bitmovin_api_sdk.models.broadcast_ts_muxing_configuration.BroadcastTsMuxingConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property audio_streams
Gets the audio_streams of this BroadcastTsMuxingConfiguration.
- Returns
The audio_streams of this BroadcastTsMuxingConfiguration.
- Return type
- property openapi_types
- property program
Gets the program of this BroadcastTsMuxingConfiguration.
Program configuration details for the Broadcast TS muxing.
- Returns
The program of this BroadcastTsMuxingConfiguration.
- Return type
- property subtitle_streams
Gets the subtitle_streams of this BroadcastTsMuxingConfiguration.
- Returns
The subtitle_streams of this BroadcastTsMuxingConfiguration.
- Return type
- property transport
Gets the transport of this BroadcastTsMuxingConfiguration.
Transport configuration details for the Broadcast TS muxing.
- Returns
The transport of this BroadcastTsMuxingConfiguration.
- Return type
- property video_streams
Gets the video_streams of this BroadcastTsMuxingConfiguration.
- Returns
The video_streams of this BroadcastTsMuxingConfiguration.
- Return type
bitmovin_api_sdk.models.broadcast_ts_muxing_information module
bitmovin_api_sdk.models.broadcast_ts_program_configuration module
- class bitmovin_api_sdk.models.broadcast_ts_program_configuration.BroadcastTsProgramConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property insert_program_clock_ref_on_pes
Gets the insert_program_clock_ref_on_pes of this BroadcastTsProgramConfiguration.
Insert Program Clock References (PCRs) on all packetized elemementary stream packets. When false, indicates that PCRs should be inserted on every PES header. This parameter is effective only when the PCR packet identifier is the same as a video or audio elementary stream.
- Returns
The insert_program_clock_ref_on_pes of this BroadcastTsProgramConfiguration.
- Return type
bool
- property openapi_types
- property pid_for_pmt
Gets the pid_for_pmt of this BroadcastTsProgramConfiguration.
An integer value. Packet identifier (PID) to use for Program Map Table (PMT). Recommended value is 2 x programNumber.
- Returns
The pid_for_pmt of this BroadcastTsProgramConfiguration.
- Return type
int
- property program_clock_ref_interval
Gets the program_clock_ref_interval of this BroadcastTsProgramConfiguration.
Interval between Program Clock References (PCRs) in milliseconds. Defines the period between PCR fields inserted in the stream. The default value is 90ms.
- Returns
The program_clock_ref_interval of this BroadcastTsProgramConfiguration.
- Return type
int
- property program_number
Gets the program_number of this BroadcastTsProgramConfiguration.
An integer value. Value for program_number field in Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.
- Returns
The program_number of this BroadcastTsProgramConfiguration.
- Return type
int
bitmovin_api_sdk.models.broadcast_ts_subtitle_input_stream_configuration module
- class bitmovin_api_sdk.models.broadcast_ts_subtitle_input_stream_configuration.BroadcastTsSubtitleInputStreamConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property packet_identifier
Gets the packet_identifier of this BroadcastTsSubtitleInputStreamConfiguration.
An integer value. Packet Identifier (PID) for this stream.
- Returns
The packet_identifier of this BroadcastTsSubtitleInputStreamConfiguration.
- Return type
int
- property rate
Gets the rate of this BroadcastTsSubtitleInputStreamConfiguration.
The rate parameter determines the maximum rate in bits per second that should be used for the subtitle stream. The valid range is 100 to 60 000 000 bps or 0. If the value is set to 0, we will examine the first 100 packets of subtitle packet data and use the highest rate that was computed. If the value is set too low, not enough to accommodate the subtitle bit-rate, then some PES packets corresponding to DVB subtitle stream will be dropped. This parameter is optional and the default value is 0.
- Returns
The rate of this BroadcastTsSubtitleInputStreamConfiguration.
- Return type
int
- property stream_id
Gets the stream_id of this BroadcastTsSubtitleInputStreamConfiguration.
The UUID of the subtitle stream to which this configuration belongs to. This has to be an ID of an subtitle stream that has been added to the current muxing.
- Returns
The stream_id of this BroadcastTsSubtitleInputStreamConfiguration.
- Return type
string_types
bitmovin_api_sdk.models.broadcast_ts_transport_configuration module
- class bitmovin_api_sdk.models.broadcast_ts_transport_configuration.BroadcastTsTransportConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property initial_presentation_time_stamp
Gets the initial_presentation_time_stamp of this BroadcastTsTransportConfiguration.
Presentation time stamp value for the first video frame. The timestamp is specified in the timescale of 90000
- Returns
The initial_presentation_time_stamp of this BroadcastTsTransportConfiguration.
- Return type
float
- property initial_program_clock_reference
Gets the initial_program_clock_reference of this BroadcastTsTransportConfiguration.
Program Clock Reference value at the beginning of the first packet for the transport stream. The PCR is specified in the timescale of 90000
- Returns
The initial_program_clock_reference of this BroadcastTsTransportConfiguration.
- Return type
float
- property muxrate
Gets the muxrate of this BroadcastTsTransportConfiguration.
Output rate in bps. The value zero implies to use minimal rate. The minimal rate leaves approximately 15kbps of null packets in the stream.
- Returns
The muxrate of this BroadcastTsTransportConfiguration.
- Return type
float
- property openapi_types
- property pat_repetition_rate_per_sec
Gets the pat_repetition_rate_per_sec of this BroadcastTsTransportConfiguration.
Program Association Table (PAT) repetition rate per second. Number of PATs per second.
- Returns
The pat_repetition_rate_per_sec of this BroadcastTsTransportConfiguration.
- Return type
float
- property pmt_repetition_rate_per_sec
Gets the pmt_repetition_rate_per_sec of this BroadcastTsTransportConfiguration.
Program Map Table (PMT) repetition rate per second. Number of PMTs for each program per second.
- Returns
The pmt_repetition_rate_per_sec of this BroadcastTsTransportConfiguration.
- Return type
float
- property prevent_empty_adaption_fields_in_video
Gets the prevent_empty_adaption_fields_in_video of this BroadcastTsTransportConfiguration.
If true, prevents adaptation fields with length field equal to zero in video, i.e., zero-length AF. Please note that this condition can only occur when pesAlign for the input stream is set to true.
- Returns
The prevent_empty_adaption_fields_in_video of this BroadcastTsTransportConfiguration.
- Return type
bool
- property stop_on_error
Gets the stop_on_error of this BroadcastTsTransportConfiguration.
Stop mux on errors. If true, implies halt multiplexing when any error is encountered. If false, errors are ignored and multiplexing continues. Note that the recovery from an error will usually result in an illegal transport stream and artifacts on a decoder.
- Returns
The stop_on_error of this BroadcastTsTransportConfiguration.
- Return type
bool
- property variable_mux_rate
Gets the variable_mux_rate of this BroadcastTsTransportConfiguration.
When false, the output stream is created at a constant bit rate. When true, the output rate is allowed to vary from a maximum rate set by the muxrate parameter down to the minimum required to carry the stream.
- Returns
The variable_mux_rate of this BroadcastTsTransportConfiguration.
- Return type
bool
bitmovin_api_sdk.models.broadcast_ts_video_input_stream_configuration module
- class bitmovin_api_sdk.models.broadcast_ts_video_input_stream_configuration.BroadcastTsVideoInputStreamConfiguration(**kwargs)[source]
Bases:
BroadcastTsInputStreamConfiguration- property attribute_map
- property insert_access_unit_delimiter_in_avc
Gets the insert_access_unit_delimiter_in_avc of this BroadcastTsVideoInputStreamConfiguration.
If true, add access unit delimiters (AUD) to AVC stream if AUD is missing from input elementary stream.
- Returns
The insert_access_unit_delimiter_in_avc of this BroadcastTsVideoInputStreamConfiguration.
- Return type
bool
- property max_decode_delay
Gets the max_decode_delay of this BroadcastTsVideoInputStreamConfiguration.
Maximum Decoder Delay in 90 KHz cycles. When non-zero, the difference between the PCR and the DTS for each picture as it is inserted into the output transport stream is limited to this number of 90 KHz cycles. Values below 1000 are treated as 0 and ignored. Valid Range [0, 1000-900000]
- Returns
The max_decode_delay of this BroadcastTsVideoInputStreamConfiguration.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.burn_in_subtitle_dvb_sub module
- class bitmovin_api_sdk.models.burn_in_subtitle_dvb_sub.BurnInSubtitleDvbSub(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property input_stream_id
Gets the input_stream_id of this BurnInSubtitleDvbSub.
Id of an IngestInputStream which specifies the stream of the DVB-SUB subtitles (required)
- Returns
The input_stream_id of this BurnInSubtitleDvbSub.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.burn_in_subtitle_srt module
- class bitmovin_api_sdk.models.burn_in_subtitle_srt.BurnInSubtitleSrt(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property character_encoding
Gets the character_encoding of this BurnInSubtitleSrt.
Character encoding of the SRT file (required)
- Returns
The character_encoding of this BurnInSubtitleSrt.
- Return type
- property input
Gets the input of this BurnInSubtitleSrt.
The input location to get the SRT file from (required)
- Returns
The input of this BurnInSubtitleSrt.
- Return type
- property openapi_types
bitmovin_api_sdk.models.caption_character_encoding module
- class bitmovin_api_sdk.models.caption_character_encoding.CaptionCharacterEncoding(value)[source]
Bases:
EnumAn enumeration.
- ANSI_X3_4_1968 = 'ANSI_X3.4-1968'
- ANSI_X3_4_1986 = 'ANSI_X3.4-1986'
- ARABIC = 'ARABIC'
- ARMSCII_8 = 'ARMSCII-8'
- ASCII = 'ASCII'
- ASMO_708 = 'ASMO-708'
- BIG5 = 'BIG5'
- BIG5HKSCS = 'BIG5HKSCS'
- BIG5_HKSCS = 'BIG5-HKSCS'
- BIG5_HKSCS_1999 = 'BIG5-HKSCS:1999'
- BIG5_HKSCS_2001 = 'BIG5-HKSCS:2001'
- BIG5_HKSCS_2004 = 'BIG5-HKSCS:2004'
- BIG5_HKSCS_2008 = 'BIG5-HKSCS:2008'
- BIGFIVE = 'BIGFIVE'
- BIG_5 = 'BIG-5'
- BIG_FIVE = 'BIG-FIVE'
- C99 = 'C99'
- CHAR = 'CHAR'
- CHINESE = 'CHINESE'
- CN = 'CN'
- CN_BIG5 = 'CN-BIG5'
- CN_GB = 'CN-GB'
- CN_GB_ISOIR165 = 'CN-GB-ISOIR165'
- CP1131 = 'CP1131'
- CP1133 = 'CP1133'
- CP1250 = 'CP1250'
- CP1251 = 'CP1251'
- CP1252 = 'CP1252'
- CP1253 = 'CP1253'
- CP1254 = 'CP1254'
- CP1255 = 'CP1255'
- CP1256 = 'CP1256'
- CP1257 = 'CP1257'
- CP1258 = 'CP1258'
- CP1361 = 'CP1361'
- CP154 = 'CP154'
- CP367 = 'CP367'
- CP819 = 'CP819'
- CP850 = 'CP850'
- CP862 = 'CP862'
- CP866 = 'CP866'
- CP874 = 'CP874'
- CP932 = 'CP932'
- CP936 = 'CP936'
- CP949 = 'CP949'
- CP950 = 'CP950'
- CSASCII = 'CSASCII'
- CSBIG5 = 'CSBIG5'
- CSEUCKR = 'CSEUCKR'
- CSEUCPKDFMTJAPANESE = 'CSEUCPKDFMTJAPANESE'
- CSEUCTW = 'CSEUCTW'
- CSGB2312 = 'CSGB2312'
- CSHALFWIDTHKATAKANA = 'CSHALFWIDTHKATAKANA'
- CSHPROMAN8 = 'CSHPROMAN8'
- CSIBM866 = 'CSIBM866'
- CSISO14JISC6220RO = 'CSISO14JISC6220RO'
- CSISO159JISX02121990 = 'CSISO159JISX02121990'
- CSISO2022CN = 'CSISO2022CN'
- CSISO2022JP = 'CSISO2022JP'
- CSISO2022JP2 = 'CSISO2022JP2'
- CSISO2022KR = 'CSISO2022KR'
- CSISO57GB1988 = 'CSISO57GB1988'
- CSISO58GB231280 = 'CSISO58GB231280'
- CSISO87JISX0208 = 'CSISO87JISX0208'
- CSISOLATIN1 = 'CSISOLATIN1'
- CSISOLATIN2 = 'CSISOLATIN2'
- CSISOLATIN3 = 'CSISOLATIN3'
- CSISOLATIN4 = 'CSISOLATIN4'
- CSISOLATIN5 = 'CSISOLATIN5'
- CSISOLATIN6 = 'CSISOLATIN6'
- CSISOLATINARABIC = 'CSISOLATINARABIC'
- CSISOLATINCYRILLIC = 'CSISOLATINCYRILLIC'
- CSISOLATINGREEK = 'CSISOLATINGREEK'
- CSISOLATINHEBREW = 'CSISOLATINHEBREW'
- CSKOI8R = 'CSKOI8R'
- CSKSC56011987 = 'CSKSC56011987'
- CSKZ1048 = 'CSKZ1048'
- CSMACINTOSH = 'CSMACINTOSH'
- CSPC850MULTILINGUAL = 'CSPC850MULTILINGUAL'
- CSPC862LATINHEBREW = 'CSPC862LATINHEBREW'
- CSPTCP154 = 'CSPTCP154'
- CSSHIFTJIS = 'CSSHIFTJIS'
- CSUCS4 = 'CSUCS4'
- CSUNICODE = 'CSUNICODE'
- CSUNICODE11 = 'CSUNICODE11'
- CSUNICODE11UTF7 = 'CSUNICODE11UTF7'
- CSVISCII = 'CSVISCII'
- CYRILLIC = 'CYRILLIC'
- CYRILLIC_ASIAN = 'CYRILLIC-ASIAN'
- ECMA_114 = 'ECMA-114'
- ECMA_118 = 'ECMA-118'
- ELOT_928 = 'ELOT_928'
- EUCCN = 'EUCCN'
- EUCJP = 'EUCJP'
- EUCKR = 'EUCKR'
- EUCTW = 'EUCTW'
- EUC_CN = 'EUC-CN'
- EUC_JP = 'EUC-JP'
- EUC_KR = 'EUC-KR'
- EUC_TW = 'EUC-TW'
- EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE = 'EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE'
- GB18030 = 'GB18030'
- GB2312 = 'GB2312'
- GBK = 'GBK'
- GB_1988_80 = 'GB_1988-80'
- GB_2312_80 = 'GB_2312-80'
- GEORGIAN_ACADEMY = 'GEORGIAN-ACADEMY'
- GEORGIAN_PS = 'GEORGIAN-PS'
- GREEK = 'GREEK'
- GREEK8 = 'GREEK8'
- HEBREW = 'HEBREW'
- HP_ROMAN8 = 'HP-ROMAN8'
- HZ = 'HZ'
- HZ_GB_2312 = 'HZ-GB-2312'
- IBM367 = 'IBM367'
- IBM819 = 'IBM819'
- IBM850 = 'IBM850'
- IBM862 = 'IBM862'
- IBM866 = 'IBM866'
- IBM_CP1133 = 'IBM-CP1133'
- ISO646_CN = 'ISO646-CN'
- ISO646_JP = 'ISO646-JP'
- ISO646_US = 'ISO646-US'
- ISO8859_1 = 'ISO8859-1'
- ISO8859_10 = 'ISO8859-10'
- ISO8859_11 = 'ISO8859-11'
- ISO8859_13 = 'ISO8859-13'
- ISO8859_14 = 'ISO8859-14'
- ISO8859_15 = 'ISO8859-15'
- ISO8859_16 = 'ISO8859-16'
- ISO8859_2 = 'ISO8859-2'
- ISO8859_3 = 'ISO8859-3'
- ISO8859_4 = 'ISO8859-4'
- ISO8859_5 = 'ISO8859-5'
- ISO8859_6 = 'ISO8859-6'
- ISO8859_7 = 'ISO8859-7'
- ISO8859_8 = 'ISO8859-8'
- ISO8859_9 = 'ISO8859-9'
- ISO_10646_UCS_2 = 'ISO-10646-UCS-2'
- ISO_10646_UCS_4 = 'ISO-10646-UCS-4'
- ISO_2022_CN = 'ISO-2022-CN'
- ISO_2022_CN_EXT = 'ISO-2022-CN-EXT'
- ISO_2022_JP = 'ISO-2022-JP'
- ISO_2022_JP_1 = 'ISO-2022-JP-1'
- ISO_2022_JP_2 = 'ISO-2022-JP-2'
- ISO_2022_KR = 'ISO-2022-KR'
- ISO_646_IRV_1991 = 'ISO_646.IRV:1991'
- ISO_8859_1 = 'ISO-8859-1'
- ISO_8859_10 = 'ISO-8859-10'
- ISO_8859_10_1992 = 'ISO_8859-10:1992'
- ISO_8859_11 = 'ISO-8859-11'
- ISO_8859_13 = 'ISO-8859-13'
- ISO_8859_14 = 'ISO-8859-14'
- ISO_8859_14_1998 = 'ISO_8859-14:1998'
- ISO_8859_15 = 'ISO-8859-15'
- ISO_8859_15_1998 = 'ISO_8859-15:1998'
- ISO_8859_16 = 'ISO-8859-16'
- ISO_8859_16_2001 = 'ISO_8859-16:2001'
- ISO_8859_1_1987 = 'ISO_8859-1:1987'
- ISO_8859_2 = 'ISO-8859-2'
- ISO_8859_2_1987 = 'ISO_8859-2:1987'
- ISO_8859_3 = 'ISO-8859-3'
- ISO_8859_3_1988 = 'ISO_8859-3:1988'
- ISO_8859_4 = 'ISO-8859-4'
- ISO_8859_4_1988 = 'ISO_8859-4:1988'
- ISO_8859_5 = 'ISO-8859-5'
- ISO_8859_5_1988 = 'ISO_8859-5:1988'
- ISO_8859_6 = 'ISO-8859-6'
- ISO_8859_6_1987 = 'ISO_8859-6:1987'
- ISO_8859_7 = 'ISO-8859-7'
- ISO_8859_7_1987 = 'ISO_8859-7:1987'
- ISO_8859_7_2003 = 'ISO_8859-7:2003'
- ISO_8859_8 = 'ISO-8859-8'
- ISO_8859_8_1988 = 'ISO_8859-8:1988'
- ISO_8859_9 = 'ISO-8859-9'
- ISO_8859_9_1989 = 'ISO_8859-9:1989'
- ISO_CELTIC = 'ISO-CELTIC'
- ISO_IR_100 = 'ISO-IR-100'
- ISO_IR_101 = 'ISO-IR-101'
- ISO_IR_109 = 'ISO-IR-109'
- ISO_IR_110 = 'ISO-IR-110'
- ISO_IR_126 = 'ISO-IR-126'
- ISO_IR_127 = 'ISO-IR-127'
- ISO_IR_138 = 'ISO-IR-138'
- ISO_IR_14 = 'ISO-IR-14'
- ISO_IR_144 = 'ISO-IR-144'
- ISO_IR_148 = 'ISO-IR-148'
- ISO_IR_149 = 'ISO-IR-149'
- ISO_IR_157 = 'ISO-IR-157'
- ISO_IR_159 = 'ISO-IR-159'
- ISO_IR_165 = 'ISO-IR-165'
- ISO_IR_166 = 'ISO-IR-166'
- ISO_IR_179 = 'ISO-IR-179'
- ISO_IR_199 = 'ISO-IR-199'
- ISO_IR_203 = 'ISO-IR-203'
- ISO_IR_226 = 'ISO-IR-226'
- ISO_IR_57 = 'ISO-IR-57'
- ISO_IR_58 = 'ISO-IR-58'
- ISO_IR_6 = 'ISO-IR-6'
- ISO_IR_87 = 'ISO-IR-87'
- JAVA = 'JAVA'
- JIS0208 = 'JIS0208'
- JISX0201_1976 = 'JISX0201-1976'
- JIS_C6220_1969_RO = 'JIS_C6220-1969-RO'
- JIS_C6226_1983 = 'JIS_C6226-1983'
- JIS_X0201 = 'JIS_X0201'
- JIS_X0208 = 'JIS_X0208'
- JIS_X0208_1983 = 'JIS_X0208-1983'
- JIS_X0208_1990 = 'JIS_X0208-1990'
- JIS_X0212 = 'JIS_X0212'
- JIS_X0212_1990 = 'JIS_X0212-1990'
- JIS_X0212_1990_0 = 'JIS_X0212.1990-0'
- JOHAB = 'JOHAB'
- JP = 'JP'
- KOI8_R = 'KOI8-R'
- KOI8_RU = 'KOI8-RU'
- KOI8_T = 'KOI8-T'
- KOI8_U = 'KOI8-U'
- KOREAN = 'KOREAN'
- KSC_5601 = 'KSC_5601'
- KS_C_5601_1987 = 'KS_C_5601-1987'
- KS_C_5601_1989 = 'KS_C_5601-1989'
- KZ_1048 = 'KZ-1048'
- L1 = 'L1'
- L10 = 'L10'
- L2 = 'L2'
- L3 = 'L3'
- L4 = 'L4'
- L5 = 'L5'
- L6 = 'L6'
- L7 = 'L7'
- L8 = 'L8'
- LATIN1 = 'LATIN1'
- LATIN10 = 'LATIN10'
- LATIN2 = 'LATIN2'
- LATIN3 = 'LATIN3'
- LATIN4 = 'LATIN4'
- LATIN5 = 'LATIN5'
- LATIN6 = 'LATIN6'
- LATIN7 = 'LATIN7'
- LATIN8 = 'LATIN8'
- LATIN_9 = 'LATIN-9'
- MAC = 'MAC'
- MACARABIC = 'MACARABIC'
- MACCENTRALEUROPE = 'MACCENTRALEUROPE'
- MACCROATIAN = 'MACCROATIAN'
- MACCYRILLIC = 'MACCYRILLIC'
- MACGREEK = 'MACGREEK'
- MACHEBREW = 'MACHEBREW'
- MACICELAND = 'MACICELAND'
- MACINTOSH = 'MACINTOSH'
- MACROMAN = 'MACROMAN'
- MACROMANIA = 'MACROMANIA'
- MACTHAI = 'MACTHAI'
- MACTURKISH = 'MACTURKISH'
- MACUKRAINE = 'MACUKRAINE'
- MS936 = 'MS936'
- MS_ANSI = 'MS-ANSI'
- MS_ARAB = 'MS-ARAB'
- MS_CYRL = 'MS-CYRL'
- MS_EE = 'MS-EE'
- MS_GREEK = 'MS-GREEK'
- MS_HEBR = 'MS-HEBR'
- MS_KANJI = 'MS_KANJI'
- MS_TURK = 'MS-TURK'
- MULELAO_1 = 'MULELAO-1'
- NEXTSTEP = 'NEXTSTEP'
- PT154 = 'PT154'
- PTCP154 = 'PTCP154'
- R8 = 'R8'
- RK1048 = 'RK1048'
- ROMAN8 = 'ROMAN8'
- SHIFT_JIS = 'SHIFT-JIS'
- SJIS = 'SJIS'
- STRK1048_2002 = 'STRK1048-2002'
- TCVN = 'TCVN'
- TCVN5712_1 = 'TCVN5712-1'
- TCVN5712_1_1993 = 'TCVN5712-1:1993'
- TCVN_5712 = 'TCVN-5712'
- TIS620 = 'TIS620'
- TIS620_0 = 'TIS620-0'
- TIS620_2529_1 = 'TIS620.2529-1'
- TIS620_2533_0 = 'TIS620.2533-0'
- TIS620_2533_1 = 'TIS620.2533-1'
- TIS_620 = 'TIS-620'
- UCS_2 = 'UCS-2'
- UCS_2BE = 'UCS-2BE'
- UCS_2LE = 'UCS-2LE'
- UCS_2_INTERNAL = 'UCS-2-INTERNAL'
- UCS_2_SWAPPED = 'UCS-2-SWAPPED'
- UCS_4 = 'UCS-4'
- UCS_4BE = 'UCS-4BE'
- UCS_4LE = 'UCS-4LE'
- UCS_4_INTERNAL = 'UCS-4-INTERNAL'
- UCS_4_SWAPPED = 'UCS-4-SWAPPED'
- UHC = 'UHC'
- UNICODEBIG = 'UNICODEBIG'
- UNICODELITTLE = 'UNICODELITTLE'
- UNICODE_1_1 = 'UNICODE-1-1'
- UNICODE_1_1_UTF_7 = 'UNICODE-1-1-UTF-7'
- US = 'US'
- US_ASCII = 'US-ASCII'
- UTF_16 = 'UTF-16'
- UTF_16BE = 'UTF-16BE'
- UTF_16LE = 'UTF-16LE'
- UTF_32 = 'UTF-32'
- UTF_32BE = 'UTF-32BE'
- UTF_32LE = 'UTF-32LE'
- UTF_7 = 'UTF-7'
- UTF_8 = 'UTF-8'
- VISCII = 'VISCII'
- VISCII1_1_1 = 'VISCII1.1-1'
- WCHAR_T = 'WCHAR_T'
- WINBALTRIM = 'WINBALTRIM'
- WINDOWS_1250 = 'WINDOWS-1250'
- WINDOWS_1251 = 'WINDOWS-1251'
- WINDOWS_1252 = 'WINDOWS-1252'
- WINDOWS_1253 = 'WINDOWS-1253'
- WINDOWS_1254 = 'WINDOWS-1254'
- WINDOWS_1255 = 'WINDOWS-1255'
- WINDOWS_1256 = 'WINDOWS-1256'
- WINDOWS_1257 = 'WINDOWS-1257'
- WINDOWS_1258 = 'WINDOWS-1258'
- WINDOWS_874 = 'WINDOWS-874'
- WINDOWS_936 = 'WINDOWS-936'
- X0201 = 'X0201'
- X0208 = 'X0208'
- X0212 = 'X0212'
bitmovin_api_sdk.models.cdn_output module
- class bitmovin_api_sdk.models.cdn_output.CdnOutput(**kwargs)[source]
Bases:
Output- property attribute_map
- property cdn_provider
Gets the cdn_provider of this CdnOutput.
CDN Provider of the Output
- Returns
The cdn_provider of this CdnOutput.
- Return type
- property domain_name
Gets the domain_name of this CdnOutput.
Domain name for public access to CDN content
- Returns
The domain_name of this CdnOutput.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.cdn_provider module
bitmovin_api_sdk.models.cdn_usage module
- class bitmovin_api_sdk.models.cdn_usage.CdnUsage(**kwargs)[source]
Bases:
object- property attribute_map
- property from_
Gets the from_ of this CdnUsage.
UTC timestamp which marks the beginning of the time period for which the usage statistics are retrieved.
- Returns
The from_ of this CdnUsage.
- Return type
datetime
- property openapi_types
- property storage_usage
Gets the storage_usage of this CdnUsage.
Storage usage in GB per month.
- Returns
The storage_usage of this CdnUsage.
- Return type
float
- property to
Gets the to of this CdnUsage.
UTC timestamp which marks the end of the time period for which the usage statistics are retrieved. The end date is exclusive. For example, if end is 2019-03-29T13:05:00Z, the cost and usage data are retrieved from the start date up to, but not including, 2019-03-29T13:05:00Z.
- Returns
The to of this CdnUsage.
- Return type
datetime
- property transfer_usage
Gets the transfer_usage of this CdnUsage.
Transfer usage in GB.
- Returns
The transfer_usage of this CdnUsage.
- Return type
float
bitmovin_api_sdk.models.cdn_usage_statistics module
- class bitmovin_api_sdk.models.cdn_usage_statistics.CdnUsageStatistics(**kwargs)[source]
Bases:
object- property attribute_map
- property from_
Gets the from_ of this CdnUsageStatistics.
UTC timestamp which marks the beginning of the time period for which the usage statistics are retrieved.
- Returns
The from_ of this CdnUsageStatistics.
- Return type
datetime
- property openapi_types
- property storage_usage_total
Gets the storage_usage_total of this CdnUsageStatistics.
Total storage usage in GB per month.
- Returns
The storage_usage_total of this CdnUsageStatistics.
- Return type
float
- property to
Gets the to of this CdnUsageStatistics.
UTC timestamp which marks the end of the time period for which the usage statistics are retrieved. The end date is exclusive. For example, if end is 2019-03-28T13:05:00Z, the cost and usage data are retrieved from the start date up to, but not including, 2019-03-28T13:05:00Z.
- Returns
The to of this CdnUsageStatistics.
- Return type
datetime
- property transfer_usage_total
Gets the transfer_usage_total of this CdnUsageStatistics.
Total transfer usage in GB.
- Returns
The transfer_usage_total of this CdnUsageStatistics.
- Return type
float
bitmovin_api_sdk.models.cea608708_subtitle_configuration module
- class bitmovin_api_sdk.models.cea608708_subtitle_configuration.Cea608708SubtitleConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property passthrough_activated
Gets the passthrough_activated of this Cea608708SubtitleConfiguration.
If enabled, CEA 608 an CEA 708 subtitles will be copied from the input video stream to the output video stream. Note: This does not work, if the output framerate is different than the input framerate (except doubling the framerate with deinterlacing per field)
- Returns
The passthrough_activated of this Cea608708SubtitleConfiguration.
- Return type
bool
- property passthrough_mode
Gets the passthrough_mode of this Cea608708SubtitleConfiguration.
- Returns
The passthrough_mode of this Cea608708SubtitleConfiguration.
- Return type
bitmovin_api_sdk.models.cea608_caption_input_stream module
- class bitmovin_api_sdk.models.cea608_caption_input_stream.Cea608CaptionInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property channel
Gets the channel of this Cea608CaptionInputStream.
The channel number of the subtitle on the respective stream position (required)
- Returns
The channel of this Cea608CaptionInputStream.
- Return type
- property input_id
Gets the input_id of this Cea608CaptionInputStream.
Id of the Input (required)
- Returns
The input_id of this Cea608CaptionInputStream.
- Return type
string_types
- property input_path
Gets the input_path of this Cea608CaptionInputStream.
Path to media file (required)
- Returns
The input_path of this Cea608CaptionInputStream.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.cea608_channel_type module
bitmovin_api_sdk.models.cea708_caption_input_stream module
- class bitmovin_api_sdk.models.cea708_caption_input_stream.Cea708CaptionInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property channel
Gets the channel of this Cea708CaptionInputStream.
The channel number of the subtitle on the respective stream position. Must not be smaller than 1 (required)
- Returns
The channel of this Cea708CaptionInputStream.
- Return type
int
- property input_id
Gets the input_id of this Cea708CaptionInputStream.
Id of the Input (required)
- Returns
The input_id of this Cea708CaptionInputStream.
- Return type
string_types
- property input_path
Gets the input_path of this Cea708CaptionInputStream.
Path to media file (required)
- Returns
The input_path of this Cea708CaptionInputStream.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.cenc_drm module
- class bitmovin_api_sdk.models.cenc_drm.CencDrm(**kwargs)[source]
Bases:
Drm- property attribute_map
- property enable_piff_compatibility
Gets the enable_piff_compatibility of this CencDrm.
Enables compatibility with the Protected Interoperable File Format (PIFF) specification
- Returns
The enable_piff_compatibility of this CencDrm.
- Return type
bool
- property encryption_mode
Gets the encryption_mode of this CencDrm.
The encryption method to use. Default is CTR (required)
- Returns
The encryption_mode of this CencDrm.
- Return type
- property fair_play
Gets the fair_play of this CencDrm.
Configuration for FairPlay DRM
- Returns
The fair_play of this CencDrm.
- Return type
- property iv_size
Gets the iv_size of this CencDrm.
Size of the initialization vector
- Returns
The iv_size of this CencDrm.
- Return type
- property key
Gets the key of this CencDrm.
16 byte encryption key, 32 hexadecimal characters (required)
- Returns
The key of this CencDrm.
- Return type
string_types
- property kid
Gets the kid of this CencDrm.
16 byte encryption key id. Required for any other DRM but FairPlay
- Returns
The kid of this CencDrm.
- Return type
string_types
- property marlin
Gets the marlin of this CencDrm.
Configuration for Marlin DRM
- Returns
The marlin of this CencDrm.
- Return type
- property openapi_types
- property play_ready
Gets the play_ready of this CencDrm.
Configuration for PlayReady DRM
- Returns
The play_ready of this CencDrm.
- Return type
- property widevine
Gets the widevine of this CencDrm.
Configuration for Widevine DRM
- Returns
The widevine of this CencDrm.
- Return type
bitmovin_api_sdk.models.cenc_fair_play module
- class bitmovin_api_sdk.models.cenc_fair_play.CencFairPlay(**kwargs)[source]
Bases:
object- property attribute_map
- property iv
Gets the iv of this CencFairPlay.
Initialization vector as hexadecimal string
- Returns
The iv of this CencFairPlay.
- Return type
string_types
- property openapi_types
- property uri
Gets the uri of this CencFairPlay.
URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.
- Returns
The uri of this CencFairPlay.
- Return type
string_types
bitmovin_api_sdk.models.cenc_marlin module
bitmovin_api_sdk.models.cenc_play_ready module
- class bitmovin_api_sdk.models.cenc_play_ready.CencPlayReady(**kwargs)[source]
Bases:
object- property additional_information
Gets the additional_information of this CencPlayReady.
- Returns
The additional_information of this CencPlayReady.
- Return type
- property attribute_map
- property la_url
Gets the la_url of this CencPlayReady.
Url of the license server. Either the laUrl or the pssh needs to be provided.
- Returns
The la_url of this CencPlayReady.
- Return type
string_types
- property openapi_types
- property pssh
Gets the pssh of this CencPlayReady.
Base64 encoded pssh payload.
- Returns
The pssh of this CencPlayReady.
- Return type
string_types
bitmovin_api_sdk.models.cenc_widevine module
bitmovin_api_sdk.models.channel_layout module
bitmovin_api_sdk.models.channels_attribute_for_audio module
bitmovin_api_sdk.models.check_output_permissions_request module
- class bitmovin_api_sdk.models.check_output_permissions_request.CheckOutputPermissionsRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property path
Gets the path of this CheckOutputPermissionsRequest.
The path on the storage for which permissions should be checked. In AWS S3 terminology, this corresponds to a “prefix”. To perform the check, an empty test file (WritePermissionTestFile.txt) will be created in this location. Defaults to an empty string, which corresponds to the root directory.
- Returns
The path of this CheckOutputPermissionsRequest.
- Return type
string_types
bitmovin_api_sdk.models.check_output_permissions_response module
- class bitmovin_api_sdk.models.check_output_permissions_response.CheckOutputPermissionsResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property failure_reason
Gets the failure_reason of this CheckOutputPermissionsResponse.
Contains nothing if the check succeeded. Otherwise, contains a message explaining why it failed.
- Returns
The failure_reason of this CheckOutputPermissionsResponse.
- Return type
string_types
- property openapi_types
- property output_id
Gets the output_id of this CheckOutputPermissionsResponse.
Id of the output for which permissions were checked
- Returns
The output_id of this CheckOutputPermissionsResponse.
- Return type
string_types
- property output_type
Gets the output_type of this CheckOutputPermissionsResponse.
The type of the output for which permissions were checked
- Returns
The output_type of this CheckOutputPermissionsResponse.
- Return type
- property passed
Gets the passed of this CheckOutputPermissionsResponse.
Indicates if permissions on the storage are configured correctly to be used as output target by the Bitmovin encoder. If “false”, failureReason will provide additional information.
- Returns
The passed of this CheckOutputPermissionsResponse.
- Return type
bool
- property path
Gets the path of this CheckOutputPermissionsResponse.
The path on the storage for which permissions were checked. In AWS S3 terminology, this corresponds to a “prefix”. An empty string corresponds to the root directory.
- Returns
The path of this CheckOutputPermissionsResponse.
- Return type
string_types
bitmovin_api_sdk.models.chroma_location module
bitmovin_api_sdk.models.chunked_text_muxing module
- class bitmovin_api_sdk.models.chunked_text_muxing.ChunkedTextMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property openapi_types
- property segment_length
Gets the segment_length of this ChunkedTextMuxing.
Length of the segments in seconds (required)
- Returns
The segment_length of this ChunkedTextMuxing.
- Return type
float
- property segment_naming
Gets the segment_naming of this ChunkedTextMuxing.
Segment naming policy
- Returns
The segment_naming of this ChunkedTextMuxing.
- Return type
string_types
- property segment_naming_template
Gets the segment_naming_template of this ChunkedTextMuxing.
Segment naming policy containing one or both of the following placeholders: - ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - ‘{segment_rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.
- Returns
The segment_naming_template of this ChunkedTextMuxing.
- Return type
string_types
- property segments_muxed
Gets the segments_muxed of this ChunkedTextMuxing.
Number of segments which have been encoded
- Returns
The segments_muxed of this ChunkedTextMuxing.
- Return type
int
- property start_offset
Gets the start_offset of this ChunkedTextMuxing.
Offset of MPEG-TS timestamps in seconds. This only affects streams with [WebVttConfiguration](#/Encoding/PostEncodingConfigurationsSubtitlesWebVtt). If set, the X-TIMESTAMP-MAP will be added as described in the [HLS specification](https://datatracker.ietf.org/doc/html/rfc8216#section-3.5). For example, if set to 10 seconds, X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000 will be added after each WEBVTT header. The default for ChunkedTextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for startOffset for [TsMuxings](#/Encoding/PostEncodingEncodingsMuxingsTsByEncodingId) and [ProgressiveTsMuxings](#/Encoding/PostEncodingEncodingsMuxingsProgressiveTsByEncodingId) is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same startOffset.
- Returns
The start_offset of this ChunkedTextMuxing.
- Return type
int
bitmovin_api_sdk.models.clear_key_drm module
- class bitmovin_api_sdk.models.clear_key_drm.ClearKeyDrm(**kwargs)[source]
Bases:
Drm- property attribute_map
- property key
Gets the key of this ClearKeyDrm.
16 byte encryption key, 32 hexadecimal characters (required)
- Returns
The key of this ClearKeyDrm.
- Return type
string_types
- property kid
Gets the kid of this ClearKeyDrm.
16 byte key id (required)
- Returns
The kid of this ClearKeyDrm.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.closed_captions_media_info module
- class bitmovin_api_sdk.models.closed_captions_media_info.ClosedCaptionsMediaInfo(**kwargs)[source]
Bases:
SegmentsMediaInfo- property attribute_map
- property forced
Gets the forced of this ClosedCaptionsMediaInfo.
A value of true indicates that the Rendition contains content which is considered essential to play.
- Returns
The forced of this ClosedCaptionsMediaInfo.
- Return type
bool
- property instream_id
Gets the instream_id of this ClosedCaptionsMediaInfo.
Specifies a Rendition within the segments in the Media Playlist. (See HLS spec 4.3.4.1. EXT-X-MEDIA INSTREAM-ID) (required)
- Returns
The instream_id of this ClosedCaptionsMediaInfo.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.cloud_region module
- class bitmovin_api_sdk.models.cloud_region.CloudRegion(value)[source]
Bases:
EnumAn enumeration.
- AFRICA = 'AFRICA'
- AKAMAI_BR_GRU = 'AKAMAI_BR_GRU'
- AKAMAI_ES_MAD = 'AKAMAI_ES_MAD'
- AKAMAI_FR_PAR = 'AKAMAI_FR_PAR'
- AKAMAI_ID_CGK = 'AKAMAI_ID_CGK'
- AKAMAI_IN_MAA = 'AKAMAI_IN_MAA'
- AKAMAI_IT_MIL = 'AKAMAI_IT_MIL'
- AKAMAI_JP_OSA = 'AKAMAI_JP_OSA'
- AKAMAI_NL_AMS = 'AKAMAI_NL_AMS'
- AKAMAI_SE_STO = 'AKAMAI_SE_STO'
- AKAMAI_US_LAX = 'AKAMAI_US_LAX'
- AKAMAI_US_MIA = 'AKAMAI_US_MIA'
- AKAMAI_US_ORD = 'AKAMAI_US_ORD'
- AKAMAI_US_SEA = 'AKAMAI_US_SEA'
- ASIA = 'ASIA'
- AUSTRALIA = 'AUSTRALIA'
- AUTO = 'AUTO'
- AWS = 'AWS'
- AWS_AP_NORTHEAST_1 = 'AWS_AP_NORTHEAST_1'
- AWS_AP_NORTHEAST_2 = 'AWS_AP_NORTHEAST_2'
- AWS_AP_SOUTHEAST_1 = 'AWS_AP_SOUTHEAST_1'
- AWS_AP_SOUTHEAST_2 = 'AWS_AP_SOUTHEAST_2'
- AWS_AP_SOUTH_1 = 'AWS_AP_SOUTH_1'
- AWS_CA_CENTRAL_1 = 'AWS_CA_CENTRAL_1'
- AWS_EU_CENTRAL_1 = 'AWS_EU_CENTRAL_1'
- AWS_EU_NORTH_1 = 'AWS_EU_NORTH_1'
- AWS_EU_WEST_1 = 'AWS_EU_WEST_1'
- AWS_EU_WEST_2 = 'AWS_EU_WEST_2'
- AWS_EU_WEST_3 = 'AWS_EU_WEST_3'
- AWS_SA_EAST_1 = 'AWS_SA_EAST_1'
- AWS_US_EAST_1 = 'AWS_US_EAST_1'
- AWS_US_EAST_2 = 'AWS_US_EAST_2'
- AWS_US_WEST_1 = 'AWS_US_WEST_1'
- AWS_US_WEST_2 = 'AWS_US_WEST_2'
- AZURE_ASIA_EAST = 'AZURE_ASIA_EAST'
- AZURE_ASIA_SOUTHEAST = 'AZURE_ASIA_SOUTHEAST'
- AZURE_AUSTRALIA_EAST = 'AZURE_AUSTRALIA_EAST'
- AZURE_AUSTRALIA_SOUTHEAST = 'AZURE_AUSTRALIA_SOUTHEAST'
- AZURE_BRAZIL_SOUTH = 'AZURE_BRAZIL_SOUTH'
- AZURE_CANADA_CENTRAL = 'AZURE_CANADA_CENTRAL'
- AZURE_EUROPE_NORTH = 'AZURE_EUROPE_NORTH'
- AZURE_EUROPE_WEST = 'AZURE_EUROPE_WEST'
- AZURE_FRANCE_CENTRAL = 'AZURE_FRANCE_CENTRAL'
- AZURE_GERMANY_WESTCENTRAL = 'AZURE_GERMANY_WESTCENTRAL'
- AZURE_INDIA_CENTRAL = 'AZURE_INDIA_CENTRAL'
- AZURE_INDIA_SOUTH = 'AZURE_INDIA_SOUTH'
- AZURE_JAPAN_EAST = 'AZURE_JAPAN_EAST'
- AZURE_JAPAN_WEST = 'AZURE_JAPAN_WEST'
- AZURE_KOREA_CENTRAL = 'AZURE_KOREA_CENTRAL'
- AZURE_UAE_NORTH = 'AZURE_UAE_NORTH'
- AZURE_UK_SOUTH = 'AZURE_UK_SOUTH'
- AZURE_US_CENTRAL = 'AZURE_US_CENTRAL'
- AZURE_US_EAST = 'AZURE_US_EAST'
- AZURE_US_EAST2 = 'AZURE_US_EAST2'
- AZURE_US_NORTH_CENTRAL = 'AZURE_US_NORTH_CENTRAL'
- AZURE_US_SOUTH_CENTRAL = 'AZURE_US_SOUTH_CENTRAL'
- AZURE_US_WEST = 'AZURE_US_WEST'
- AZURE_US_WEST2 = 'AZURE_US_WEST2'
- EUROPE = 'EUROPE'
- EXTERNAL = 'EXTERNAL'
- GOOGLE = 'GOOGLE'
- GOOGLE_ASIA_EAST_1 = 'GOOGLE_ASIA_EAST_1'
- GOOGLE_ASIA_EAST_2 = 'GOOGLE_ASIA_EAST_2'
- GOOGLE_ASIA_NORTHEAST_1 = 'GOOGLE_ASIA_NORTHEAST_1'
- GOOGLE_ASIA_SOUTHEAST_1 = 'GOOGLE_ASIA_SOUTHEAST_1'
- GOOGLE_ASIA_SOUTH_1 = 'GOOGLE_ASIA_SOUTH_1'
- GOOGLE_AUSTRALIA_SOUTHEAST_1 = 'GOOGLE_AUSTRALIA_SOUTHEAST_1'
- GOOGLE_EUROPE_NORTH_1 = 'GOOGLE_EUROPE_NORTH_1'
- GOOGLE_EUROPE_WEST_1 = 'GOOGLE_EUROPE_WEST_1'
- GOOGLE_EUROPE_WEST_2 = 'GOOGLE_EUROPE_WEST_2'
- GOOGLE_EUROPE_WEST_3 = 'GOOGLE_EUROPE_WEST_3'
- GOOGLE_EUROPE_WEST_4 = 'GOOGLE_EUROPE_WEST_4'
- GOOGLE_ME_CENTRAL_2 = 'GOOGLE_ME_CENTRAL_2'
- GOOGLE_NORTHAMERICA_NORTHEAST_1 = 'GOOGLE_NORTHAMERICA_NORTHEAST_1'
- GOOGLE_SOUTHAMERICA_EAST_1 = 'GOOGLE_SOUTHAMERICA_EAST_1'
- GOOGLE_US_CENTRAL_1 = 'GOOGLE_US_CENTRAL_1'
- GOOGLE_US_EAST_1 = 'GOOGLE_US_EAST_1'
- GOOGLE_US_EAST_4 = 'GOOGLE_US_EAST_4'
- GOOGLE_US_WEST_1 = 'GOOGLE_US_WEST_1'
- GOOGLE_US_WEST_2 = 'GOOGLE_US_WEST_2'
- NORTH_AMERICA = 'NORTH_AMERICA'
- OCI_EU_FRANKFURT_1 = 'OCI_EU_FRANKFURT_1'
- OCI_US_ASHBURN_1 = 'OCI_US_ASHBURN_1'
- SOUTH_AMERICA = 'SOUTH_AMERICA'
bitmovin_api_sdk.models.cmaf_muxing module
- class bitmovin_api_sdk.models.cmaf_muxing.CmafMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property frames_per_cmaf_chunk
Gets the frames_per_cmaf_chunk of this CmafMuxing.
Number of media frames per CMAF chunk. Defaults to: Length of a segment in frames. Minimum: 1. Maximum: Length of a segment in frames.
- Returns
The frames_per_cmaf_chunk of this CmafMuxing.
- Return type
int
- property init_segment_name
Gets the init_segment_name of this CmafMuxing.
Init segment name
- Returns
The init_segment_name of this CmafMuxing.
- Return type
string_types
- property init_segment_name_template
Gets the init_segment_name_template of this CmafMuxing.
Segment naming policy containing a placeholder of the format ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.
- Returns
The init_segment_name_template of this CmafMuxing.
- Return type
string_types
- property openapi_types
- property segment_length
Gets the segment_length of this CmafMuxing.
Length of the fragments in seconds (required)
- Returns
The segment_length of this CmafMuxing.
- Return type
float
- property segment_naming
Gets the segment_naming of this CmafMuxing.
Segment naming policy
- Returns
The segment_naming of this CmafMuxing.
- Return type
string_types
- property segment_naming_template
Gets the segment_naming_template of this CmafMuxing.
Segment naming policy containing one or both of the following placeholders: - ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - ‘{segment_rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.
- Returns
The segment_naming_template of this CmafMuxing.
- Return type
string_types
- property segments_muxed
Gets the segments_muxed of this CmafMuxing.
Number of segments which have been encoded
- Returns
The segments_muxed of this CmafMuxing.
- Return type
int
bitmovin_api_sdk.models.codec_config_type module
- class bitmovin_api_sdk.models.codec_config_type.CodecConfigType(value)[source]
Bases:
EnumAn enumeration.
- AAC = 'AAC'
- AC3 = 'AC3'
- AUDIO_PASSTHROUGH = 'AUDIO_PASSTHROUGH'
- AV1 = 'AV1'
- DD = 'DD'
- DDPLUS = 'DDPLUS'
- DOLBY_ATMOS = 'DOLBY_ATMOS'
- DTS = 'DTS'
- DTSX = 'DTSX'
- DTS_PASSTHROUGH = 'DTS_PASSTHROUGH'
- DVB_SUBTITLE = 'DVB_SUBTITLE'
- EAC3 = 'EAC3'
- H262 = 'H262'
- H264 = 'H264'
- H265 = 'H265'
- HE_AAC_V1 = 'HE_AAC_V1'
- HE_AAC_V2 = 'HE_AAC_V2'
- IMSC = 'IMSC'
- MJPEG = 'MJPEG'
- MP2 = 'MP2'
- MP3 = 'MP3'
- OPUS = 'OPUS'
- PCM = 'PCM'
- VORBIS = 'VORBIS'
- VP8 = 'VP8'
- VP9 = 'VP9'
- WEBVTT = 'WEBVTT'
bitmovin_api_sdk.models.codec_config_type_response module
- class bitmovin_api_sdk.models.codec_config_type_response.CodecConfigTypeResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property type
Gets the type of this CodecConfigTypeResponse.
The type of the codec config
- Returns
The type of this CodecConfigTypeResponse.
- Return type
bitmovin_api_sdk.models.codec_configuration module
- class bitmovin_api_sdk.models.codec_configuration.CodecConfiguration(**kwargs)[source]
Bases:
BitmovinResource- discriminator_value_class_map = {'AAC': 'AacAudioConfiguration', 'AC3': 'Ac3AudioConfiguration', 'AUDIO_PASSTHROUGH': 'PassthroughAudioConfiguration', 'AV1': 'Av1VideoConfiguration', 'DD': 'DolbyDigitalAudioConfiguration', 'DDPLUS': 'DolbyDigitalPlusAudioConfiguration', 'DOLBY_ATMOS': 'DolbyAtmosAudioConfiguration', 'DTS': 'DtsAudioConfiguration', 'DTSX': 'DtsXAudioConfiguration', 'DTS_PASSTHROUGH': 'DtsPassthroughAudioConfiguration', 'DVB_SUBTITLE': 'DvbSubtitleConfiguration', 'EAC3': 'Eac3AudioConfiguration', 'H262': 'H262VideoConfiguration', 'H264': 'H264VideoConfiguration', 'H265': 'H265VideoConfiguration', 'HE_AAC_V1': 'HeAacV1AudioConfiguration', 'HE_AAC_V2': 'HeAacV2AudioConfiguration', 'IMSC': 'ImscConfiguration', 'MJPEG': 'MjpegVideoConfiguration', 'MP2': 'Mp2AudioConfiguration', 'MP3': 'Mp3AudioConfiguration', 'OPUS': 'OpusAudioConfiguration', 'PCM': 'PcmAudioConfiguration', 'VORBIS': 'VorbisAudioConfiguration', 'VP8': 'Vp8VideoConfiguration', 'VP9': 'Vp9VideoConfiguration', 'WEBVTT': 'WebVttConfiguration'}
bitmovin_api_sdk.models.color_config module
- class bitmovin_api_sdk.models.color_config.ColorConfig(**kwargs)[source]
Bases:
object- property attribute_map
- property chroma_location
Gets the chroma_location of this ColorConfig.
The chroma location to be applied
- Returns
The chroma_location of this ColorConfig.
- Return type
- property color_primaries
Gets the color_primaries of this ColorConfig.
The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.
- Returns
The color_primaries of this ColorConfig.
- Return type
- property color_range
Gets the color_range of this ColorConfig.
The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.
- Returns
The color_range of this ColorConfig.
- Return type
- property color_space
Gets the color_space of this ColorConfig.
The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.
- Returns
The color_space of this ColorConfig.
- Return type
- property color_transfer
Gets the color_transfer of this ColorConfig.
The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.
- Returns
The color_transfer of this ColorConfig.
- Return type
- property copy_chroma_location_flag
Gets the copy_chroma_location_flag of this ColorConfig.
Copy the chroma location setting from the input source
- Returns
The copy_chroma_location_flag of this ColorConfig.
- Return type
bool
- property copy_color_primaries_flag
Gets the copy_color_primaries_flag of this ColorConfig.
Copy the color primaries setting from the input source
- Returns
The copy_color_primaries_flag of this ColorConfig.
- Return type
bool
- property copy_color_range_flag
Gets the copy_color_range_flag of this ColorConfig.
Copy the color range setting from the input source
- Returns
The copy_color_range_flag of this ColorConfig.
- Return type
bool
- property copy_color_space_flag
Gets the copy_color_space_flag of this ColorConfig.
Copy the color space setting from the input source
- Returns
The copy_color_space_flag of this ColorConfig.
- Return type
bool
- property copy_color_transfer_flag
Gets the copy_color_transfer_flag of this ColorConfig.
Copy the color transfer setting from the input source
- Returns
The copy_color_transfer_flag of this ColorConfig.
- Return type
bool
- property input_color_primaries
Gets the input_color_primaries of this ColorConfig.
Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.
- Returns
The input_color_primaries of this ColorConfig.
- Return type
- property input_color_range
Gets the input_color_range of this ColorConfig.
Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.
- Returns
The input_color_range of this ColorConfig.
- Return type
- property input_color_space
Gets the input_color_space of this ColorConfig.
Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.
- Returns
The input_color_space of this ColorConfig.
- Return type
- property input_color_transfer
Gets the input_color_transfer of this ColorConfig.
Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.
- Returns
The input_color_transfer of this ColorConfig.
- Return type
- property openapi_types
bitmovin_api_sdk.models.color_primaries module
- class bitmovin_api_sdk.models.color_primaries.ColorPrimaries(value)[source]
Bases:
EnumAn enumeration.
- BT2020 = 'BT2020'
- BT470BG = 'BT470BG'
- BT470M = 'BT470M'
- BT709 = 'BT709'
- FILM = 'FILM'
- JEDEC_P22 = 'JEDEC_P22'
- SMPTE170M = 'SMPTE170M'
- SMPTE240M = 'SMPTE240M'
- SMPTE428 = 'SMPTE428'
- SMPTE431 = 'SMPTE431'
- SMPTE432 = 'SMPTE432'
- SMPTEST428_1 = 'SMPTEST428_1'
- UNSPECIFIED = 'UNSPECIFIED'
bitmovin_api_sdk.models.color_range module
bitmovin_api_sdk.models.color_space module
- class bitmovin_api_sdk.models.color_space.ColorSpace(value)[source]
Bases:
EnumAn enumeration.
- BT2020_CL = 'BT2020_CL'
- BT2020_NCL = 'BT2020_NCL'
- BT470BG = 'BT470BG'
- BT709 = 'BT709'
- FCC = 'FCC'
- RGB = 'RGB'
- SMPTE170M = 'SMPTE170M'
- SMPTE2085 = 'SMPTE2085'
- SMPTE240M = 'SMPTE240M'
- UNSPECIFIED = 'UNSPECIFIED'
- YCGCO = 'YCGCO'
- YCOCG = 'YCOCG'
bitmovin_api_sdk.models.color_transfer module
- class bitmovin_api_sdk.models.color_transfer.ColorTransfer(value)[source]
Bases:
EnumAn enumeration.
- ARIB_STD_B67 = 'ARIB_STD_B67'
- BT1361_ECG = 'BT1361_ECG'
- BT2020_10 = 'BT2020_10'
- BT2020_12 = 'BT2020_12'
- BT709 = 'BT709'
- GAMMA22 = 'GAMMA22'
- GAMMA28 = 'GAMMA28'
- IEC61966_2_1 = 'IEC61966_2_1'
- IEC61966_2_4 = 'IEC61966_2_4'
- LINEAR = 'LINEAR'
- LOG = 'LOG'
- LOG_SQRT = 'LOG_SQRT'
- SMPTE170M = 'SMPTE170M'
- SMPTE2084 = 'SMPTE2084'
- SMPTE240M = 'SMPTE240M'
- SMPTE428 = 'SMPTE428'
- UNSPECIFIED = 'UNSPECIFIED'
bitmovin_api_sdk.models.concatenation_input_configuration module
- class bitmovin_api_sdk.models.concatenation_input_configuration.ConcatenationInputConfiguration(**kwargs)[source]
Bases:
object- property aspect_mode
Gets the aspect_mode of this ConcatenationInputConfiguration.
Specifies the aspect mode that is used when adapting to the main input stream’s aspect ratio
- Returns
The aspect_mode of this ConcatenationInputConfiguration.
- Return type
- property attribute_map
- property input_stream_id
Gets the input_stream_id of this ConcatenationInputConfiguration.
The ID of the input stream to be concatenated. This can be an ingest input stream or a trimming input stream (required)
- Returns
The input_stream_id of this ConcatenationInputConfiguration.
- Return type
string_types
- property is_main
Gets the is_main of this ConcatenationInputConfiguration.
Exactly one input stream of a concatenation must have this set to true, which will be used as reference for scaling, aspect ratio, FPS, sample rate, etc.
- Returns
The is_main of this ConcatenationInputConfiguration.
- Return type
bool
- property openapi_types
- property padding_after
Gets the padding_after of this ConcatenationInputConfiguration.
Inserts a padding sequence (black frames and/or silent audio) after the input stream.
- Returns
The padding_after of this ConcatenationInputConfiguration.
- Return type
- property padding_before
Gets the padding_before of this ConcatenationInputConfiguration.
Inserts a padding sequence (black frames and/or silent audio) before the input stream.
- Returns
The padding_before of this ConcatenationInputConfiguration.
- Return type
- property position
Gets the position of this ConcatenationInputConfiguration.
A unique integer value that determines concatenation order (required)
- Returns
The position of this ConcatenationInputConfiguration.
- Return type
int
bitmovin_api_sdk.models.concatenation_input_stream module
- class bitmovin_api_sdk.models.concatenation_input_stream.ConcatenationInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property concatenation
Gets the concatenation of this ConcatenationInputStream.
Concatenation configuration for the output of this stream
- Returns
The concatenation of this ConcatenationInputStream.
- Return type
- property openapi_types
bitmovin_api_sdk.models.condition module
- class bitmovin_api_sdk.models.condition.Condition(**kwargs)[source]
Bases:
AbstractCondition- property attribute
Gets the attribute of this Condition.
The attribute that should be used for the evaluation. Valid values include, depending on the context: - HEIGHT - WIDTH - BITRATE - FPS - ASPECTRATIO - INPUTSTREAM - LANGUAGE - CHANNELFORMAT - CHANNELLAYOUT - STREAMCOUNT - AUDIOSTREAMCOUNT - VIDEOSTREAMCOUNT - DURATION - ROTATION (required)
- Returns
The attribute of this Condition.
- Return type
string_types
- property attribute_map
- property openapi_types
- property operator
Gets the operator of this Condition.
The operator that should be used for the evaluation (required)
- Returns
The operator of this Condition.
- Return type
- property value
Gets the value of this Condition.
The value that should be used for comparison (required)
- Returns
The value of this Condition.
- Return type
string_types
bitmovin_api_sdk.models.condition_attribute module
- class bitmovin_api_sdk.models.condition_attribute.ConditionAttribute(value)[source]
Bases:
EnumAn enumeration.
- ASPECTRATIO = 'ASPECTRATIO'
- AUDIOSTREAMCOUNT = 'AUDIOSTREAMCOUNT'
- BITRATE = 'BITRATE'
- CHANNELFORMAT = 'CHANNELFORMAT'
- CHANNELLAYOUT = 'CHANNELLAYOUT'
- CONNECTION_STATUS = 'CONNECTION_STATUS'
- CONNECTION_STATUS_JUST_CHANGED = 'CONNECTION_STATUS_JUST_CHANGED'
- DURATION = 'DURATION'
- FPS = 'FPS'
- HEIGHT = 'HEIGHT'
- INPUTSTREAM = 'INPUTSTREAM'
- LANGUAGE = 'LANGUAGE'
- ROTATION = 'ROTATION'
- STREAMCOUNT = 'STREAMCOUNT'
- VIDEOSTREAMCOUNT = 'VIDEOSTREAMCOUNT'
- WIDTH = 'WIDTH'
bitmovin_api_sdk.models.condition_operator module
bitmovin_api_sdk.models.condition_type module
bitmovin_api_sdk.models.conform_filter module
- class bitmovin_api_sdk.models.conform_filter.ConformFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property openapi_types
- property target_fps
Gets the target_fps of this ConformFilter.
The FPS the input should be changed to.
- Returns
The target_fps of this ConformFilter.
- Return type
float
bitmovin_api_sdk.models.content_protection module
- class bitmovin_api_sdk.models.content_protection.ContentProtection(**kwargs)[source]
Bases:
DashMuxingRepresentation- property attribute_map
- property drm_id
Gets the drm_id of this ContentProtection.
DRM Id (required)
- Returns
The drm_id of this ContentProtection.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.convert_scc_caption module
- class bitmovin_api_sdk.models.convert_scc_caption.ConvertSccCaption(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property file_name
Gets the file_name of this ConvertSccCaption.
Name of the captions file (required)
- Returns
The file_name of this ConvertSccCaption.
- Return type
string_types
- property input
Gets the input of this ConvertSccCaption.
The input location to get the scc file from (required)
- Returns
The input of this ConvertSccCaption.
- Return type
- property openapi_types
- property output_format
Gets the output_format of this ConvertSccCaption.
- Returns
The output_format of this ConvertSccCaption.
- Return type
- property outputs
Gets the outputs of this ConvertSccCaption.
- Returns
The outputs of this ConvertSccCaption.
- Return type
list[EncodingOutput]
- property web_vtt_settings
Gets the web_vtt_settings of this ConvertSccCaption.
Optional settings when converting SCC to WebVTT
- Returns
The web_vtt_settings of this ConvertSccCaption.
- Return type
bitmovin_api_sdk.models.convert_scc_caption_web_vtt_settings module
- class bitmovin_api_sdk.models.convert_scc_caption_web_vtt_settings.ConvertSccCaptionWebVttSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property position_mode
Gets the position_mode of this ConvertSccCaptionWebVttSettings.
- Returns
The position_mode of this ConvertSccCaptionWebVttSettings.
- Return type
- property remove_color
Gets the remove_color of this ConvertSccCaptionWebVttSettings.
Remove color information when converting SCC to WebVTT
- Returns
The remove_color of this ConvertSccCaptionWebVttSettings.
- Return type
bool
- property remove_flash
Gets the remove_flash of this ConvertSccCaptionWebVttSettings.
Remove flash (blinking) information when converting SCC to WebVTT
- Returns
The remove_flash of this ConvertSccCaptionWebVttSettings.
- Return type
bool
bitmovin_api_sdk.models.convert_scc_position_mode module
bitmovin_api_sdk.models.crop_filter module
- class bitmovin_api_sdk.models.crop_filter.CropFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property bottom
Gets the bottom of this CropFilter.
Amount of pixels that will be cropped of the input video from the bottom. Must be zero or a positive value.
- Returns
The bottom of this CropFilter.
- Return type
int
- property left
Gets the left of this CropFilter.
Amount of pixels that will be cropped of the input video from the left side. Must be zero or a positive value.
- Returns
The left of this CropFilter.
- Return type
int
- property openapi_types
- property right
Gets the right of this CropFilter.
Amount of pixels that will be cropped of the input video from the right side. Must be zero or a positive value.
- Returns
The right of this CropFilter.
- Return type
int
- property top
Gets the top of this CropFilter.
Amount of pixels that will be cropped of the input video from the top. Must be zero or a positive value.
- Returns
The top of this CropFilter.
- Return type
int
- property unit
Gets the unit of this CropFilter.
- Returns
The unit of this CropFilter.
- Return type
bitmovin_api_sdk.models.custom_attribute module
- class bitmovin_api_sdk.models.custom_attribute.CustomAttribute(**kwargs)[source]
Bases:
object- property attribute_map
- property key
Gets the key of this CustomAttribute.
unique string identifier for the custom attribute (required)
- Returns
The key of this CustomAttribute.
- Return type
string_types
- property openapi_types
- property value
Gets the value of this CustomAttribute.
value of the custom attribute
- Returns
The value of this CustomAttribute.
- Return type
string_types
bitmovin_api_sdk.models.custom_data module
- class bitmovin_api_sdk.models.custom_data.CustomData(**kwargs)[source]
Bases:
object- property attribute_map
- property created_at
Gets the created_at of this CustomData.
Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this CustomData.
- Return type
datetime
- property custom_data
Gets the custom_data of this CustomData.
User-specific meta data. This can hold a custom JSON object.
- Returns
The custom_data of this CustomData.
- Return type
dict(str, object)
- property openapi_types
bitmovin_api_sdk.models.custom_player_build_details module
- class bitmovin_api_sdk.models.custom_player_build_details.CustomPlayerBuildDetails(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property domains
Gets the domains of this CustomPlayerBuildDetails.
The domains that the player is locked to. If not set the player will only work with ‘localhost’. Not more than 49 additional domains can be added. (required)
- Returns
The domains of this CustomPlayerBuildDetails.
- Return type
list[string_types]
- property openapi_types
- property player_version
Gets the player_version of this CustomPlayerBuildDetails.
The player version that should be used for the custom player build. If not set the ‘latest’ version is used. (required)
- Returns
The player_version of this CustomPlayerBuildDetails.
- Return type
string_types
bitmovin_api_sdk.models.custom_player_build_download module
- class bitmovin_api_sdk.models.custom_player_build_download.CustomPlayerBuildDownload(**kwargs)[source]
Bases:
object- property attribute_map
- property download_link
Gets the download_link of this CustomPlayerBuildDownload.
The link to download the custom built player (required)
- Returns
The download_link of this CustomPlayerBuildDownload.
- Return type
string_types
- property expires_at
Gets the expires_at of this CustomPlayerBuildDownload.
Until this date the download link is valid and can be downloaded. (required)
- Returns
The expires_at of this CustomPlayerBuildDownload.
- Return type
datetime
- property openapi_types
bitmovin_api_sdk.models.custom_player_build_status module
- class bitmovin_api_sdk.models.custom_player_build_status.CustomPlayerBuildStatus(**kwargs)[source]
Bases:
object- property attribute_map
- property eta
Gets the eta of this CustomPlayerBuildStatus.
The estimated time span of the custom player build in seconds.
- Returns
The eta of this CustomPlayerBuildStatus.
- Return type
int
- property messages
Gets the messages of this CustomPlayerBuildStatus.
- Returns
The messages of this CustomPlayerBuildStatus.
- Return type
- property openapi_types
- property progress
Gets the progress of this CustomPlayerBuildStatus.
The actual progress of the custom player build. (required)
- Returns
The progress of this CustomPlayerBuildStatus.
- Return type
int
- property status
Gets the status of this CustomPlayerBuildStatus.
Status of the player build (required)
- Returns
The status of this CustomPlayerBuildStatus.
- Return type
- property subtasks
Gets the subtasks of this CustomPlayerBuildStatus.
- Returns
The subtasks of this CustomPlayerBuildStatus.
- Return type
string_types
bitmovin_api_sdk.models.custom_tag module
- class bitmovin_api_sdk.models.custom_tag.CustomTag(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property data
Gets the data of this CustomTag.
The data to be contained in the custom tag. (required)
- Returns
The data of this CustomTag.
- Return type
string_types
- property keyframe_id
Gets the keyframe_id of this CustomTag.
Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode.
- Returns
The keyframe_id of this CustomTag.
- Return type
string_types
- property openapi_types
- property position_mode
Gets the position_mode of this CustomTag.
The positioning mode that should be used when inserting the placement opportunity (required)
- Returns
The position_mode of this CustomTag.
- Return type
- property segment
Gets the segment of this CustomTag.
The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode.
- Returns
The segment of this CustomTag.
- Return type
int
- property time
Gets the time of this CustomTag.
Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode.
- Returns
The time of this CustomTag.
- Return type
float
bitmovin_api_sdk.models.custom_web_player_build_domain module
- class bitmovin_api_sdk.models.custom_web_player_build_domain.CustomWebPlayerBuildDomain(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property domain
Gets the domain of this CustomWebPlayerBuildDomain.
Domain where the player is allowed to play (required)
- Returns
The domain of this CustomWebPlayerBuildDomain.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.custom_xml_element module
- class bitmovin_api_sdk.models.custom_xml_element.CustomXmlElement(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property data
Gets the data of this CustomXmlElement.
String representation of the XML element (required)
- Returns
The data of this CustomXmlElement.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.daily_statistics module
- class bitmovin_api_sdk.models.daily_statistics.DailyStatistics(**kwargs)[source]
Bases:
object- property attribute_map
- property billable_egress_bytes
Gets the billable_egress_bytes of this DailyStatistics.
- Returns
The billable_egress_bytes of this DailyStatistics.
- Return type
list[EgressInformation]
- property billable_encoding_minutes
Gets the billable_encoding_minutes of this DailyStatistics.
Billable minutes for each encoding configuration.
- Returns
The billable_encoding_minutes of this DailyStatistics.
- Return type
list[BillableEncodingMinutes]
- property billable_feature_minutes
Gets the billable_feature_minutes of this DailyStatistics.
Billable minutes for features
- Returns
The billable_feature_minutes of this DailyStatistics.
- Return type
- property billable_minutes
Gets the billable_minutes of this DailyStatistics.
The billable minutes.
- Returns
The billable_minutes of this DailyStatistics.
- Return type
float
- property billable_transmuxing_minutes
Gets the billable_transmuxing_minutes of this DailyStatistics.
Billable minutes for muxings.
- Returns
The billable_transmuxing_minutes of this DailyStatistics.
- Return type
float
- property bytes_encoded
Gets the bytes_encoded of this DailyStatistics.
Bytes encoded. (required)
- Returns
The bytes_encoded of this DailyStatistics.
- Return type
int
- property date
Gets the date of this DailyStatistics.
Date for the shown data. Format: yyyy-MM-dd (required)
- Returns
The date of this DailyStatistics.
- Return type
date
- property label
Gets the label of this DailyStatistics.
Label identifier.
- Returns
The label of this DailyStatistics.
- Return type
string_types
- property openapi_types
- property time_encoded
Gets the time_encoded of this DailyStatistics.
Time in seconds encoded for this day. (required)
- Returns
The time_encoded of this DailyStatistics.
- Return type
int
bitmovin_api_sdk.models.daily_statistics_per_label module
- class bitmovin_api_sdk.models.daily_statistics_per_label.DailyStatisticsPerLabel(**kwargs)[source]
Bases:
object- property attribute_map
- property date
Gets the date of this DailyStatisticsPerLabel.
Date, format. yyyy-MM-dd (required)
- Returns
The date of this DailyStatisticsPerLabel.
- Return type
date
- property labels
Gets the labels of this DailyStatisticsPerLabel.
List of labels and their aggregated statistics (required)
- Returns
The labels of this DailyStatisticsPerLabel.
- Return type
list[DailyStatistics]
- property openapi_types
bitmovin_api_sdk.models.dash_chunked_text_representation module
bitmovin_api_sdk.models.dash_cmaf_representation module
bitmovin_api_sdk.models.dash_edition_compatibility module
bitmovin_api_sdk.models.dash_fmp4_drm_representation module
- class bitmovin_api_sdk.models.dash_fmp4_drm_representation.DashFmp4DrmRepresentation(**kwargs)[source]
Bases:
DashFmp4Representation- property attribute_map
- property drm_id
Gets the drm_id of this DashFmp4DrmRepresentation.
DRM Id (required)
- Returns
The drm_id of this DashFmp4DrmRepresentation.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.dash_fmp4_representation module
bitmovin_api_sdk.models.dash_imsc_representation module
- class bitmovin_api_sdk.models.dash_imsc_representation.DashImscRepresentation(**kwargs)[source]
Bases:
DashRepresentation- property attribute_map
- property imsc_url
Gets the imsc_url of this DashImscRepresentation.
URL of the referenced IMSC file (required)
- Returns
The imsc_url of this DashImscRepresentation.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.dash_manifest module
- class bitmovin_api_sdk.models.dash_manifest.DashManifest(**kwargs)[source]
Bases:
Manifest- property attribute_map
- property dash_edition_compatibility
Gets the dash_edition_compatibility of this DashManifest.
The manifest compatibility with the standard DASH Edition.
- Returns
The dash_edition_compatibility of this DashManifest.
- Return type
- property manifest_name
Gets the manifest_name of this DashManifest.
The filename of your manifest
- Returns
The manifest_name of this DashManifest.
- Return type
string_types
- property namespaces
Gets the namespaces of this DashManifest.
List of additional XML namespaces to add to the DASH Manifest
- Returns
The namespaces of this DashManifest.
- Return type
list[XmlNamespace]
- property openapi_types
- property profile
Gets the profile of this DashManifest.
Determines if segmented or progressive representations can appear in the manifest
- Returns
The profile of this DashManifest.
- Return type
bitmovin_api_sdk.models.dash_manifest_default module
- class bitmovin_api_sdk.models.dash_manifest_default.DashManifestDefault(**kwargs)[source]
Bases:
DashManifest- property attribute_map
- property encoding_id
Gets the encoding_id of this DashManifestDefault.
The id of the encoding to create a default manifest for. Either “encodingId” or “periods” is required.
- Returns
The encoding_id of this DashManifestDefault.
- Return type
string_types
- property openapi_types
- property periods
Gets the periods of this DashManifestDefault.
Adds a period for every item. Can only be used when setting “version” to “V2”. Either “periods” or “encodingId” is required.
- Returns
The periods of this DashManifestDefault.
- Return type
- property version
Gets the version of this DashManifestDefault.
Specifies the algorithm that determines which output of the given encoding is included into the manifest. Note that this is not related to the “manifestGenerator” version of the “Start” request.
- Returns
The version of this DashManifestDefault.
- Return type
bitmovin_api_sdk.models.dash_manifest_default_version module
bitmovin_api_sdk.models.dash_mp4_drm_representation module
- class bitmovin_api_sdk.models.dash_mp4_drm_representation.DashMp4DrmRepresentation(**kwargs)[source]
Bases:
DashMp4Representation- property attribute_map
- property drm_id
Gets the drm_id of this DashMp4DrmRepresentation.
DRM Id (required)
- Returns
The drm_id of this DashMp4DrmRepresentation.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.dash_mp4_representation module
- class bitmovin_api_sdk.models.dash_mp4_representation.DashMp4Representation(**kwargs)[source]
Bases:
DashMuxingRepresentation- property attribute_map
- property file_path
Gets the file_path of this DashMp4Representation.
Path to the MP4 file (required)
- Returns
The file_path of this DashMp4Representation.
- Return type
string_types
- property openapi_types
- property type
Gets the type of this DashMp4Representation.
The type of the dash representation
- Returns
The type of this DashMp4Representation.
- Return type
bitmovin_api_sdk.models.dash_muxing_representation module
- class bitmovin_api_sdk.models.dash_muxing_representation.DashMuxingRepresentation(**kwargs)[source]
Bases:
DashRepresentation- property attribute_map
- property dependency_id
Gets the dependency_id of this DashMuxingRepresentation.
Used to signal a dependency with another representation. The representation may belong to a different adaptation set
- Returns
The dependency_id of this DashMuxingRepresentation.
- Return type
string_types
- property encoding_id
Gets the encoding_id of this DashMuxingRepresentation.
UUID of an encoding (required)
- Returns
The encoding_id of this DashMuxingRepresentation.
- Return type
string_types
- property muxing_id
Gets the muxing_id of this DashMuxingRepresentation.
UUID of a muxing (required)
- Returns
The muxing_id of this DashMuxingRepresentation.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.dash_on_demand_representation_type module
bitmovin_api_sdk.models.dash_profile module
bitmovin_api_sdk.models.dash_progressive_webm_representation module
- class bitmovin_api_sdk.models.dash_progressive_webm_representation.DashProgressiveWebmRepresentation(**kwargs)[source]
Bases:
DashMuxingRepresentation- property attribute_map
- property file_path
Gets the file_path of this DashProgressiveWebmRepresentation.
Path to the Progressive WebM file (required)
- Returns
The file_path of this DashProgressiveWebmRepresentation.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.dash_representation module
- class bitmovin_api_sdk.models.dash_representation.DashRepresentation(**kwargs)[source]
Bases:
BitmovinResponse- discriminator_value_class_map = {'CHUNKED_TEXT': 'DashChunkedTextRepresentation', 'CMAF': 'DashCmafRepresentation', 'CONTENT_PROTECTION': 'ContentProtection', 'DRM_FMP4': 'DashFmp4DrmRepresentation', 'DRM_MP4': 'DashMp4DrmRepresentation', 'FMP4': 'DashFmp4Representation', 'IMSC': 'DashImscRepresentation', 'MP4': 'DashMp4Representation', 'PROGRESSIVE_WEBM': 'DashProgressiveWebmRepresentation', 'SPRITE': 'SpriteRepresentation', 'VTT': 'DashVttRepresentation', 'WEBM': 'DashWebmRepresentation'}
bitmovin_api_sdk.models.dash_representation_type module
bitmovin_api_sdk.models.dash_representation_type_discriminator module
- class bitmovin_api_sdk.models.dash_representation_type_discriminator.DashRepresentationTypeDiscriminator(value)[source]
Bases:
EnumAn enumeration.
- CHUNKED_TEXT = 'CHUNKED_TEXT'
- CMAF = 'CMAF'
- CONTENT_PROTECTION = 'CONTENT_PROTECTION'
- DRM_FMP4 = 'DRM_FMP4'
- DRM_MP4 = 'DRM_MP4'
- FMP4 = 'FMP4'
- IMSC = 'IMSC'
- MP4 = 'MP4'
- PROGRESSIVE_WEBM = 'PROGRESSIVE_WEBM'
- SPRITE = 'SPRITE'
- VTT = 'VTT'
- WEBM = 'WEBM'
bitmovin_api_sdk.models.dash_representation_type_mode module
bitmovin_api_sdk.models.dash_representation_type_response module
- class bitmovin_api_sdk.models.dash_representation_type_response.DashRepresentationTypeResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property type
Gets the type of this DashRepresentationTypeResponse.
The type of the DASH representation
- Returns
The type of this DashRepresentationTypeResponse.
- Return type
bitmovin_api_sdk.models.dash_segmented_representation module
- class bitmovin_api_sdk.models.dash_segmented_representation.DashSegmentedRepresentation(**kwargs)[source]
Bases:
DashMuxingRepresentation- property attribute_map
- property end_keyframe_id
Gets the end_keyframe_id of this DashSegmentedRepresentation.
Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.
- Returns
The end_keyframe_id of this DashSegmentedRepresentation.
- Return type
string_types
- property end_segment_number
Gets the end_segment_number of this DashSegmentedRepresentation.
Number of the last segment. Default is the last one that was encoded
- Returns
The end_segment_number of this DashSegmentedRepresentation.
- Return type
int
- property mode
Gets the mode of this DashSegmentedRepresentation.
- Returns
The mode of this DashSegmentedRepresentation.
- Return type
- property openapi_types
- property segment_path
Gets the segment_path of this DashSegmentedRepresentation.
Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET (required)
- Returns
The segment_path of this DashSegmentedRepresentation.
- Return type
string_types
- property start_keyframe_id
Gets the start_keyframe_id of this DashSegmentedRepresentation.
Id of the keyframe to start with. It takes precedence over startSegmentNumber
- Returns
The start_keyframe_id of this DashSegmentedRepresentation.
- Return type
string_types
- property start_segment_number
Gets the start_segment_number of this DashSegmentedRepresentation.
Number of the first segment
- Returns
The start_segment_number of this DashSegmentedRepresentation.
- Return type
int
- property type
Gets the type of this DashSegmentedRepresentation.
- Returns
The type of this DashSegmentedRepresentation.
- Return type
bitmovin_api_sdk.models.dash_vtt_representation module
- class bitmovin_api_sdk.models.dash_vtt_representation.DashVttRepresentation(**kwargs)[source]
Bases:
DashRepresentation- property attribute_map
- property openapi_types
- property vtt_url
Gets the vtt_url of this DashVttRepresentation.
URL of the referenced VTT file (required)
- Returns
The vtt_url of this DashVttRepresentation.
- Return type
string_types
bitmovin_api_sdk.models.dash_webm_representation module
bitmovin_api_sdk.models.decoding_error_mode module
bitmovin_api_sdk.models.default_dash_manifest_period module
- class bitmovin_api_sdk.models.default_dash_manifest_period.DefaultDashManifestPeriod(**kwargs)[source]
Bases:
object- property adaptation_sets
Gets the adaptation_sets of this DefaultDashManifestPeriod.
Adds an adaption set for every item to the period
- Returns
The adaptation_sets of this DefaultDashManifestPeriod.
- Return type
list[DefaultManifestCondition]
- property attribute_map
- property encoding_ids
Gets the encoding_ids of this DefaultDashManifestPeriod.
List the encoding ids for which the conditions should apply
- Returns
The encoding_ids of this DefaultDashManifestPeriod.
- Return type
list[string_types]
- property openapi_types
bitmovin_api_sdk.models.default_manifest_and_condition module
- class bitmovin_api_sdk.models.default_manifest_and_condition.DefaultManifestAndCondition(**kwargs)[source]
Bases:
DefaultManifestCondition- property attribute_map
- property conditions
Gets the conditions of this DefaultManifestAndCondition.
Array to perform the AND evaluation on. This conditions evaluates to true if all sub conditions evaluate to true.
- Returns
The conditions of this DefaultManifestAndCondition.
- Return type
list[DefaultManifestCondition]
- property openapi_types
bitmovin_api_sdk.models.default_manifest_attribute_condition module
- class bitmovin_api_sdk.models.default_manifest_attribute_condition.DefaultManifestAttributeCondition(**kwargs)[source]
Bases:
DefaultManifestCondition- property attribute
Gets the attribute of this DefaultManifestAttributeCondition.
The attribute that should be used for the evaluation: - audio.codec - audio.language - audio.bitrate - subtitle.format - subtitle.language - video.height - video.width - video.codec - video.bitrate - drm.type - muxing.type (required)
- Returns
The attribute of this DefaultManifestAttributeCondition.
- Return type
string_types
- property attribute_map
- property openapi_types
- property operator
Gets the operator of this DefaultManifestAttributeCondition.
The operator that should be used for the evaluation (required)
- Returns
The operator of this DefaultManifestAttributeCondition.
- Return type
- property value
Gets the value of this DefaultManifestAttributeCondition.
The value that should be used for comparison. Valid values depend on the attribute: - audio.codec (Enum; e.g., AAC, MP3, OPUS) - audio.language (String) - audio.bitrate (Integer) - subtitle.format (Enum; e.g., WEBVTT) - subtitle.language (String) - video.height (Integer) - video.width (Integer) - video.codec (Enum; e.g., AV1, H264, VP9) - video.bitrate (Integer) - drm.type (Enum; NoDrm, Cenc, CencWidevine, CencPlayReady, CencMarlin, CencFairPlay, Aes128, ClearKey, PrimeTime, Widevine, PlayReady, Marlin, FairPlay) - muxing.type (Enum; e.g., FMP4, MP4) (required)
- Returns
The value of this DefaultManifestAttributeCondition.
- Return type
string_types
bitmovin_api_sdk.models.default_manifest_condition module
bitmovin_api_sdk.models.default_manifest_or_condition module
- class bitmovin_api_sdk.models.default_manifest_or_condition.DefaultManifestOrCondition(**kwargs)[source]
Bases:
DefaultManifestCondition- property attribute_map
- property conditions
Gets the conditions of this DefaultManifestOrCondition.
Array to perform the OR evaluation on. This conditions evaluates to true if at least one sub condition evaluates to true.
- Returns
The conditions of this DefaultManifestOrCondition.
- Return type
list[DefaultManifestCondition]
- property openapi_types
bitmovin_api_sdk.models.deinterlace_auto_enable module
bitmovin_api_sdk.models.deinterlace_filter module
- class bitmovin_api_sdk.models.deinterlace_filter.DeinterlaceFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property auto_enable
Gets the auto_enable of this DeinterlaceFilter.
- Returns
The auto_enable of this DeinterlaceFilter.
- Return type
- property frame_selection_mode
Gets the frame_selection_mode of this DeinterlaceFilter.
- Returns
The frame_selection_mode of this DeinterlaceFilter.
- Return type
- property mode
Gets the mode of this DeinterlaceFilter.
- Returns
The mode of this DeinterlaceFilter.
- Return type
- property openapi_types
- property parity
Gets the parity of this DeinterlaceFilter.
- Returns
The parity of this DeinterlaceFilter.
- Return type
bitmovin_api_sdk.models.deinterlace_frame_selection_mode module
bitmovin_api_sdk.models.deinterlace_mode module
bitmovin_api_sdk.models.denoise_hqdn3d_filter module
- class bitmovin_api_sdk.models.denoise_hqdn3d_filter.DenoiseHqdn3dFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property chroma_spatial
Gets the chroma_spatial of this DenoiseHqdn3dFilter.
A non-negative floating point number which specifies spatial chroma strength. It defaults to 3.0*luma_spatial/4.0.
- Returns
The chroma_spatial of this DenoiseHqdn3dFilter.
- Return type
float
- property chroma_tmp
Gets the chroma_tmp of this DenoiseHqdn3dFilter.
A floating point number which specifies chroma temporal strength. It defaults to luma_tmp*chroma_spatial/luma_spatial.
- Returns
The chroma_tmp of this DenoiseHqdn3dFilter.
- Return type
float
- property luma_spatial
Gets the luma_spatial of this DenoiseHqdn3dFilter.
A non-negative floating point number which specifies spatial luma strength. It defaults to 4.0.
- Returns
The luma_spatial of this DenoiseHqdn3dFilter.
- Return type
float
- property luma_tmp
Gets the luma_tmp of this DenoiseHqdn3dFilter.
A floating point number which specifies luma temporal strength. It defaults to 6.0*luma_spatial/4.0.
- Returns
The luma_tmp of this DenoiseHqdn3dFilter.
- Return type
float
- property openapi_types
bitmovin_api_sdk.models.direct_file_upload_input module
- class bitmovin_api_sdk.models.direct_file_upload_input.DirectFileUploadInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property openapi_types
- property upload_url
Gets the upload_url of this DirectFileUploadInput.
The URL to be used for a file upload with HTTP PUT. Expires after 5 minutes.
- Returns
The upload_url of this DirectFileUploadInput.
- Return type
string_types
bitmovin_api_sdk.models.display_aspect_ratio module
- class bitmovin_api_sdk.models.display_aspect_ratio.DisplayAspectRatio(**kwargs)[source]
Bases:
object- property attribute_map
- property denominator
Gets the denominator of this DisplayAspectRatio.
The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used. (required)
- Returns
The denominator of this DisplayAspectRatio.
- Return type
int
- property numerator
Gets the numerator of this DisplayAspectRatio.
The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used. (required)
- Returns
The numerator of this DisplayAspectRatio.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.dolby_atmos_audio_configuration module
- class bitmovin_api_sdk.models.dolby_atmos_audio_configuration.DolbyAtmosAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property loudness_control
Gets the loudness_control of this DolbyAtmosAudioConfiguration.
Settings for loudness control (required)
- Returns
The loudness_control of this DolbyAtmosAudioConfiguration.
- Return type
- property openapi_types
bitmovin_api_sdk.models.dolby_atmos_dialogue_intelligence module
bitmovin_api_sdk.models.dolby_atmos_ingest_input_stream module
- class bitmovin_api_sdk.models.dolby_atmos_ingest_input_stream.DolbyAtmosIngestInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property input_format
Gets the input_format of this DolbyAtmosIngestInputStream.
Input file format of the Dolby Atmos input file. Set it to DAMF if the given input file is a Dolby Atmos Master File (.atmos). Set it to ADM if the given input file is an Audio Definition Model Broadcast Wave Format file (.wav) (required)
- Returns
The input_format of this DolbyAtmosIngestInputStream.
- Return type
- property input_id
Gets the input_id of this DolbyAtmosIngestInputStream.
Id of input (required)
- Returns
The input_id of this DolbyAtmosIngestInputStream.
- Return type
string_types
- property input_path
Gets the input_path of this DolbyAtmosIngestInputStream.
Path to the Dolby Atmos input file (required)
- Returns
The input_path of this DolbyAtmosIngestInputStream.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.dolby_atmos_input_format module
bitmovin_api_sdk.models.dolby_atmos_loudness_control module
- class bitmovin_api_sdk.models.dolby_atmos_loudness_control.DolbyAtmosLoudnessControl(**kwargs)[source]
Bases:
object- property attribute_map
- property dialogue_intelligence
Gets the dialogue_intelligence of this DolbyAtmosLoudnessControl.
Whether to use the Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating. Must not be “DISABLED” for meteringMode “ITU-R BS.1770-1” or “Leq (A)”, otherwise recommended value is “ENABLED” (required)
- Returns
The dialogue_intelligence of this DolbyAtmosLoudnessControl.
- Return type
- property metering_mode
Gets the metering_mode of this DolbyAtmosLoudnessControl.
Algorithm to be used for measuring loudness. Recommended value is “ITU_R_BS_1770_4” (required)
- Returns
The metering_mode of this DolbyAtmosLoudnessControl.
- Return type
- property openapi_types
- property speech_threshold
Gets the speech_threshold of this DolbyAtmosLoudnessControl.
Specifies the percentage of speech that must be detected in the metered content before using the measured speech loudness as the overall program loudness. Given as an integer percentage between 0 and 100 (0% to 100%). Recommended value is 15 (required)
- Returns
The speech_threshold of this DolbyAtmosLoudnessControl.
- Return type
int
bitmovin_api_sdk.models.dolby_atmos_metering_mode module
bitmovin_api_sdk.models.dolby_digital_audio_configuration module
- class bitmovin_api_sdk.models.dolby_digital_audio_configuration.DolbyDigitalAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property bitstream_info
Gets the bitstream_info of this DolbyDigitalAudioConfiguration.
BitstreamInfo defines metadata parameters contained in the Dolby Digital audio bitstream
- Returns
The bitstream_info of this DolbyDigitalAudioConfiguration.
- Return type
- property channel_layout
Gets the channel_layout of this DolbyDigitalAudioConfiguration.
Channel layout of the audio codec configuration.
- Returns
The channel_layout of this DolbyDigitalAudioConfiguration.
- Return type
- property downmixing
Gets the downmixing of this DolbyDigitalAudioConfiguration.
- Returns
The downmixing of this DolbyDigitalAudioConfiguration.
- Return type
- property evolution_framework_control
Gets the evolution_framework_control of this DolbyDigitalAudioConfiguration.
It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.
- Returns
The evolution_framework_control of this DolbyDigitalAudioConfiguration.
- Return type
- property loudness_control
Gets the loudness_control of this DolbyDigitalAudioConfiguration.
Settings for loudness control (required)
- Returns
The loudness_control of this DolbyDigitalAudioConfiguration.
- Return type
- property openapi_types
- property preprocessing
Gets the preprocessing of this DolbyDigitalAudioConfiguration.
- Returns
The preprocessing of this DolbyDigitalAudioConfiguration.
- Return type
bitmovin_api_sdk.models.dolby_digital_bitstream_info module
- class bitmovin_api_sdk.models.dolby_digital_bitstream_info.DolbyDigitalBitstreamInfo(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property surround_ex_mode
Gets the surround_ex_mode of this DolbyDigitalBitstreamInfo.
This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX. This parameter is used only if the encoded audio has two surround channels. An amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically. The behavior is similar to that of the surroundMode parameter.
- Returns
The surround_ex_mode of this DolbyDigitalBitstreamInfo.
- Return type
- property surround_mode
Gets the surround_mode of this DolbyDigitalBitstreamInfo.
This parameter indicates to a decoder whether the two‐channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding. When downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: ENABLED, Lo/Ro: DISABLED). When transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream. When transcoding a third-party stereo input to stereo Dolby Digital set the value to NOT_INDICATED.
- Returns
The surround_mode of this DolbyDigitalBitstreamInfo.
- Return type
bitmovin_api_sdk.models.dolby_digital_center_mix_level module
- class bitmovin_api_sdk.models.dolby_digital_center_mix_level.DolbyDigitalCenterMixLevel(value)[source]
Bases:
EnumAn enumeration.
- MINUS_1_5_DB = 'MINUS_1_5_DB'
- MINUS_3_DB = 'MINUS_3_DB'
- MINUS_4_5_DB = 'MINUS_4_5_DB'
- MINUS_6_DB = 'MINUS_6_DB'
- MINUS_INFINITY_DB = 'MINUS_INFINITY_DB'
- PLUS_1_5_DB = 'PLUS_1_5_DB'
- PLUS_3_DB = 'PLUS_3_DB'
- ZERO_DB = 'ZERO_DB'
bitmovin_api_sdk.models.dolby_digital_channel_layout module
- class bitmovin_api_sdk.models.dolby_digital_channel_layout.DolbyDigitalChannelLayout(value)[source]
Bases:
EnumAn enumeration.
- CL_3_1 = '3.1'
- CL_4_0 = '4.0'
- CL_4_1 = '4.1'
- CL_5_0 = '5.0'
- CL_5_1 = '5.1'
- CL_BACK_SURROUND = 'BACK_SURROUND'
- CL_BACK_SURROUND_LFE = 'BACK_SURROUND_LFE'
- CL_QUAD = 'QUAD'
- CL_QUAD_LFE = 'QUAD_LFE'
- CL_STEREO = 'STEREO'
- CL_SURROUND = 'SURROUND'
- MONO = 'MONO'
- NONE = 'NONE'
bitmovin_api_sdk.models.dolby_digital_dialogue_intelligence module
bitmovin_api_sdk.models.dolby_digital_downmixing module
- class bitmovin_api_sdk.models.dolby_digital_downmixing.DolbyDigitalDownmixing(**kwargs)[source]
Bases:
object- property attribute_map
- property lo_ro_center_mix_level
Gets the lo_ro_center_mix_level of this DolbyDigitalDownmixing.
The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.
- Returns
The lo_ro_center_mix_level of this DolbyDigitalDownmixing.
- Return type
- property lo_ro_surround_mix_level
Gets the lo_ro_surround_mix_level of this DolbyDigitalDownmixing.
The level shift applied to the surround channels when downmixing to one Lo/Ro output.
- Returns
The lo_ro_surround_mix_level of this DolbyDigitalDownmixing.
- Return type
- property lt_rt_center_mix_level
Gets the lt_rt_center_mix_level of this DolbyDigitalDownmixing.
The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.
- Returns
The lt_rt_center_mix_level of this DolbyDigitalDownmixing.
- Return type
- property lt_rt_surround_mix_level
Gets the lt_rt_surround_mix_level of this DolbyDigitalDownmixing.
The level shift applied to the surround channels when downmixing to one Lt/Rt output.
- Returns
The lt_rt_surround_mix_level of this DolbyDigitalDownmixing.
- Return type
- property openapi_types
- property preferred_mode
Gets the preferred_mode of this DolbyDigitalDownmixing.
- Returns
The preferred_mode of this DolbyDigitalDownmixing.
- Return type
bitmovin_api_sdk.models.dolby_digital_downmixing_preferred_mode module
bitmovin_api_sdk.models.dolby_digital_dynamic_range_compression module
- class bitmovin_api_sdk.models.dolby_digital_dynamic_range_compression.DolbyDigitalDynamicRangeCompression(**kwargs)[source]
Bases:
object- property attribute_map
- property line_mode
Gets the line_mode of this DolbyDigitalDynamicRangeCompression.
Line mode is intended for use in products providing line‐level or speaker‐level outputs, and is applicable to the widest range of products. Products such as set‐top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.
- Returns
The line_mode of this DolbyDigitalDynamicRangeCompression.
- Return type
- property openapi_types
- property rf_mode
Gets the rf_mode of this DolbyDigitalDynamicRangeCompression.
RF mode is intended for products such as a low‐cost television receivers.
- Returns
The rf_mode of this DolbyDigitalDynamicRangeCompression.
- Return type
bitmovin_api_sdk.models.dolby_digital_dynamic_range_compression_mode module
- class bitmovin_api_sdk.models.dolby_digital_dynamic_range_compression_mode.DolbyDigitalDynamicRangeCompressionMode(value)[source]
Bases:
EnumAn enumeration.
- FILM_LIGHT = 'FILM_LIGHT'
- FILM_STANDARD = 'FILM_STANDARD'
- MUSIC_LIGHT = 'MUSIC_LIGHT'
- MUSIC_STANDARD = 'MUSIC_STANDARD'
- NONE = 'NONE'
- SPEECH = 'SPEECH'
bitmovin_api_sdk.models.dolby_digital_evolution_framework_control module
bitmovin_api_sdk.models.dolby_digital_lfe_low_pass_filter module
bitmovin_api_sdk.models.dolby_digital_loudness_control module
- class bitmovin_api_sdk.models.dolby_digital_loudness_control.DolbyDigitalLoudnessControl(**kwargs)[source]
Bases:
object- property attribute_map
- property dialnorm
Gets the dialnorm of this DolbyDigitalLoudnessControl.
Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialnorm must not be set.
- Returns
The dialnorm of this DolbyDigitalLoudnessControl.
- Return type
int
- property dialogue_intelligence
Gets the dialogue_intelligence of this DolbyDigitalLoudnessControl.
This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialogueIntelligence must not be set.
- Returns
The dialogue_intelligence of this DolbyDigitalLoudnessControl.
- Return type
- property mode
Gets the mode of this DolbyDigitalLoudnessControl.
- Returns
The mode of this DolbyDigitalLoudnessControl.
- Return type
- property openapi_types
- property peak_limit
Gets the peak_limit of this DolbyDigitalLoudnessControl.
The peak value in dB to use for loudness correction. This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations peakLimit must not be set.
- Returns
The peak_limit of this DolbyDigitalLoudnessControl.
- Return type
float
- property regulation_type
Gets the regulation_type of this DolbyDigitalLoudnessControl.
This is only allowed if the mode is CORRECTION. <table> <tr><th colspan=4 align=”left”> Predefined values for each regulation type: </th></tr> <tr><td> Regulation Type </td><td> EBU R128 </td><td> ATSC A/85 Fixed </td><td> ATSC A/85 Agile</td></tr> <tr><td> Limit Mode </td><td> True Peak </td><td> True Peak </td><td> True Peak </td></tr> <tr><td> Correction Mode </td><td> PCM Normalization </td><td> PCM Normalization </td><td> Metadata Update </td></tr> <tr><td> Peak Limit </td><td> –3 dBTP </td><td> –2 dBTP </td><td> N/A </td></tr> <tr><td> Dialogue Intelligence </td><td> Off </td><td> On </td><td> On </td></tr> <tr><td> Meter Mode </td><td> ITU-R BS.1770-3 </td><td> ITU-R BS.1770-3 </td><td> ITU-R BS.1770-3 </td></tr> <tr><td> Speech Threshold </td><td> 20 </td><td> 20 </td><td> 20 </td></tr> <tr><td> Dialogue Normalization </td><td> -23 dB </td><td> -24 dB </td><td> Set to measured loudness </td></tr> </table>
- Returns
The regulation_type of this DolbyDigitalLoudnessControl.
- Return type
bitmovin_api_sdk.models.dolby_digital_loudness_control_mode module
bitmovin_api_sdk.models.dolby_digital_loudness_control_regulation_type module
bitmovin_api_sdk.models.dolby_digital_ninety_degree_phase_shift module
bitmovin_api_sdk.models.dolby_digital_plus_audio_configuration module
- class bitmovin_api_sdk.models.dolby_digital_plus_audio_configuration.DolbyDigitalPlusAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property bitstream_info
Gets the bitstream_info of this DolbyDigitalPlusAudioConfiguration.
BitstreamInfo defines metadata parameters contained in the Dolby Digital Plus audio bitstream
- Returns
The bitstream_info of this DolbyDigitalPlusAudioConfiguration.
- Return type
- property channel_layout
Gets the channel_layout of this DolbyDigitalPlusAudioConfiguration.
Channel layout of the audio codec configuration.
- Returns
The channel_layout of this DolbyDigitalPlusAudioConfiguration.
- Return type
- property downmixing
Gets the downmixing of this DolbyDigitalPlusAudioConfiguration.
- Returns
The downmixing of this DolbyDigitalPlusAudioConfiguration.
- Return type
- property evolution_framework_control
Gets the evolution_framework_control of this DolbyDigitalPlusAudioConfiguration.
It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.
- Returns
The evolution_framework_control of this DolbyDigitalPlusAudioConfiguration.
- Return type
- property loudness_control
Gets the loudness_control of this DolbyDigitalPlusAudioConfiguration.
Settings for loudness control (required)
- Returns
The loudness_control of this DolbyDigitalPlusAudioConfiguration.
- Return type
- property openapi_types
- property preprocessing
Gets the preprocessing of this DolbyDigitalPlusAudioConfiguration.
- Returns
The preprocessing of this DolbyDigitalPlusAudioConfiguration.
- Return type
bitmovin_api_sdk.models.dolby_digital_plus_bitstream_info module
- class bitmovin_api_sdk.models.dolby_digital_plus_bitstream_info.DolbyDigitalPlusBitstreamInfo(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property surround_ex_mode
Gets the surround_ex_mode of this DolbyDigitalPlusBitstreamInfo.
This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX. This parameter is used only if the encoded audio has two surround channels. An amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically. The behavior is similar to that of the surroundMode parameter.
- Returns
The surround_ex_mode of this DolbyDigitalPlusBitstreamInfo.
- Return type
- property surround_mode
Gets the surround_mode of this DolbyDigitalPlusBitstreamInfo.
This parameter indicates to a decoder whether the two‐channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding. When downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: ENABLED, Lo/Ro: DISABLED). When transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream. When transcoding a third-party stereo input to stereo Dolby Digital set the value to NOT_INDICATED.
- Returns
The surround_mode of this DolbyDigitalPlusBitstreamInfo.
- Return type
bitmovin_api_sdk.models.dolby_digital_plus_center_mix_level module
- class bitmovin_api_sdk.models.dolby_digital_plus_center_mix_level.DolbyDigitalPlusCenterMixLevel(value)[source]
Bases:
EnumAn enumeration.
- MINUS_1_5_DB = 'MINUS_1_5_DB'
- MINUS_3_DB = 'MINUS_3_DB'
- MINUS_4_5_DB = 'MINUS_4_5_DB'
- MINUS_6_DB = 'MINUS_6_DB'
- MINUS_INFINITY_DB = 'MINUS_INFINITY_DB'
- PLUS_1_5_DB = 'PLUS_1_5_DB'
- PLUS_3_DB = 'PLUS_3_DB'
- ZERO_DB = 'ZERO_DB'
bitmovin_api_sdk.models.dolby_digital_plus_channel_layout module
- class bitmovin_api_sdk.models.dolby_digital_plus_channel_layout.DolbyDigitalPlusChannelLayout(value)[source]
Bases:
EnumAn enumeration.
- CL_3_1 = '3.1'
- CL_4_0 = '4.0'
- CL_4_1 = '4.1'
- CL_5_0 = '5.0'
- CL_5_1 = '5.1'
- CL_BACK_SURROUND = 'BACK_SURROUND'
- CL_BACK_SURROUND_LFE = 'BACK_SURROUND_LFE'
- CL_QUAD = 'QUAD'
- CL_QUAD_LFE = 'QUAD_LFE'
- CL_STEREO = 'STEREO'
- CL_SURROUND = 'SURROUND'
- MONO = 'MONO'
- NONE = 'NONE'
bitmovin_api_sdk.models.dolby_digital_plus_dialogue_intelligence module
bitmovin_api_sdk.models.dolby_digital_plus_downmixing module
- class bitmovin_api_sdk.models.dolby_digital_plus_downmixing.DolbyDigitalPlusDownmixing(**kwargs)[source]
Bases:
object- property attribute_map
- property lo_ro_center_mix_level
Gets the lo_ro_center_mix_level of this DolbyDigitalPlusDownmixing.
The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.
- Returns
The lo_ro_center_mix_level of this DolbyDigitalPlusDownmixing.
- Return type
- property lo_ro_surround_mix_level
Gets the lo_ro_surround_mix_level of this DolbyDigitalPlusDownmixing.
The level shift applied to the surround channels when downmixing to one Lo/Ro output.
- Returns
The lo_ro_surround_mix_level of this DolbyDigitalPlusDownmixing.
- Return type
- property lt_rt_center_mix_level
Gets the lt_rt_center_mix_level of this DolbyDigitalPlusDownmixing.
The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.
- Returns
The lt_rt_center_mix_level of this DolbyDigitalPlusDownmixing.
- Return type
- property lt_rt_surround_mix_level
Gets the lt_rt_surround_mix_level of this DolbyDigitalPlusDownmixing.
The level shift applied to the surround channels when downmixing to one Lt/Rt output.
- Returns
The lt_rt_surround_mix_level of this DolbyDigitalPlusDownmixing.
- Return type
- property openapi_types
- property preferred_mode
Gets the preferred_mode of this DolbyDigitalPlusDownmixing.
- Returns
The preferred_mode of this DolbyDigitalPlusDownmixing.
- Return type
bitmovin_api_sdk.models.dolby_digital_plus_downmixing_preferred_mode module
bitmovin_api_sdk.models.dolby_digital_plus_dynamic_range_compression module
- class bitmovin_api_sdk.models.dolby_digital_plus_dynamic_range_compression.DolbyDigitalPlusDynamicRangeCompression(**kwargs)[source]
Bases:
object- property attribute_map
- property line_mode
Gets the line_mode of this DolbyDigitalPlusDynamicRangeCompression.
Line mode is intended for use in products providing line‐level or speaker‐level outputs, and is applicable to the widest range of products. Products such as set‐top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.
- Returns
The line_mode of this DolbyDigitalPlusDynamicRangeCompression.
- Return type
- property openapi_types
- property rf_mode
Gets the rf_mode of this DolbyDigitalPlusDynamicRangeCompression.
RF mode is intended for products such as a low‐cost television receiver.
- Returns
The rf_mode of this DolbyDigitalPlusDynamicRangeCompression.
- Return type
bitmovin_api_sdk.models.dolby_digital_plus_dynamic_range_compression_mode module
- class bitmovin_api_sdk.models.dolby_digital_plus_dynamic_range_compression_mode.DolbyDigitalPlusDynamicRangeCompressionMode(value)[source]
Bases:
EnumAn enumeration.
- FILM_LIGHT = 'FILM_LIGHT'
- FILM_STANDARD = 'FILM_STANDARD'
- MUSIC_LIGHT = 'MUSIC_LIGHT'
- MUSIC_STANDARD = 'MUSIC_STANDARD'
- NONE = 'NONE'
- SPEECH = 'SPEECH'
bitmovin_api_sdk.models.dolby_digital_plus_evolution_framework_control module
bitmovin_api_sdk.models.dolby_digital_plus_lfe_low_pass_filter module
bitmovin_api_sdk.models.dolby_digital_plus_loudness_control module
- class bitmovin_api_sdk.models.dolby_digital_plus_loudness_control.DolbyDigitalPlusLoudnessControl(**kwargs)[source]
Bases:
object- property attribute_map
- property dialnorm
Gets the dialnorm of this DolbyDigitalPlusLoudnessControl.
Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other combinations dialnorm must not be set.
- Returns
The dialnorm of this DolbyDigitalPlusLoudnessControl.
- Return type
int
- property dialogue_intelligence
Gets the dialogue_intelligence of this DolbyDigitalPlusLoudnessControl.
This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other regulationType values dialogueIntelligence must not be set.
- Returns
The dialogue_intelligence of this DolbyDigitalPlusLoudnessControl.
- Return type
- property mode
Gets the mode of this DolbyDigitalPlusLoudnessControl.
- Returns
The mode of this DolbyDigitalPlusLoudnessControl.
- Return type
- property openapi_types
- property peak_limit
Gets the peak_limit of this DolbyDigitalPlusLoudnessControl.
The peak value in dB to use for loudness correction. This may only be set if the mode is PASSTHROUGH, or if the mode is CORRECTION and regulationType is MANUAL. For all other regulationType values peakLimit must not be set.
- Returns
The peak_limit of this DolbyDigitalPlusLoudnessControl.
- Return type
float
- property regulation_type
Gets the regulation_type of this DolbyDigitalPlusLoudnessControl.
This is only allowed if the mode is CORRECTION. <table> <tr><th colspan=4 align=”left”> Predefined values for each regulation type: </th></tr> <tr><td> Regulation Type </td><td> EBU R128 </td><td> ATSC A/85 Fixed </td><td> ATSC A/85 Agile</td></tr> <tr><td> Limit Mode </td><td> True Peak </td><td> True Peak </td><td> True Peak </td></tr> <tr><td> Correction Mode </td><td> PCM Normalization </td><td> PCM Normalization </td><td> Metadata Update </td></tr> <tr><td> Peak Limit </td><td> –3 dBTP </td><td> –2 dBTP </td><td> N/A </td></tr> <tr><td> Dialogue Intelligence </td><td> Off </td><td> On </td><td> On </td></tr> <tr><td> Meter Mode </td><td> ITU-R BS.1770-3 </td><td> ITU-R BS.1770-3 </td><td> ITU-R BS.1770-3 </td></tr> <tr><td> Speech Threshold </td><td> 20 </td><td> 20 </td><td> 20 </td></tr> <tr><td> Dialogue Normalization </td><td> -23 dB </td><td> -24 dB </td><td> Set to measured loudness </td></tr> </table>
- Returns
The regulation_type of this DolbyDigitalPlusLoudnessControl.
- Return type
bitmovin_api_sdk.models.dolby_digital_plus_loudness_control_mode module
bitmovin_api_sdk.models.dolby_digital_plus_loudness_control_regulation_type module
bitmovin_api_sdk.models.dolby_digital_plus_ninety_degree_phase_shift module
bitmovin_api_sdk.models.dolby_digital_plus_preprocessing module
- class bitmovin_api_sdk.models.dolby_digital_plus_preprocessing.DolbyDigitalPlusPreprocessing(**kwargs)[source]
Bases:
object- property attribute_map
- property dynamic_range_compression
Gets the dynamic_range_compression of this DolbyDigitalPlusPreprocessing.
It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression. The values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.
- Returns
The dynamic_range_compression of this DolbyDigitalPlusPreprocessing.
- Return type
- property lfe_low_pass_filter
Gets the lfe_low_pass_filter of this DolbyDigitalPlusPreprocessing.
It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel. This is only allowed if the channelLayout contains a LFE channel.
- Returns
The lfe_low_pass_filter of this DolbyDigitalPlusPreprocessing.
- Return type
- property ninety_degree_phase_shift
Gets the ninety_degree_phase_shift of this DolbyDigitalPlusPreprocessing.
- Returns
The ninety_degree_phase_shift of this DolbyDigitalPlusPreprocessing.
- Return type
- property openapi_types
- property three_db_attenuation
Gets the three_db_attenuation of this DolbyDigitalPlusPreprocessing.
- Returns
The three_db_attenuation of this DolbyDigitalPlusPreprocessing.
- Return type
bitmovin_api_sdk.models.dolby_digital_plus_surround_mix_level module
- class bitmovin_api_sdk.models.dolby_digital_plus_surround_mix_level.DolbyDigitalPlusSurroundMixLevel(value)[source]
Bases:
EnumAn enumeration.
- MINUS_1_5_DB = 'MINUS_1_5_DB'
- MINUS_3_DB = 'MINUS_3_DB'
- MINUS_4_5_DB = 'MINUS_4_5_DB'
- MINUS_6_DB = 'MINUS_6_DB'
- MINUS_INFINITY_DB = 'MINUS_INFINITY_DB'
bitmovin_api_sdk.models.dolby_digital_plus_surround_mode module
bitmovin_api_sdk.models.dolby_digital_plus_three_db_attenuation module
bitmovin_api_sdk.models.dolby_digital_preprocessing module
- class bitmovin_api_sdk.models.dolby_digital_preprocessing.DolbyDigitalPreprocessing(**kwargs)[source]
Bases:
object- property attribute_map
- property dynamic_range_compression
Gets the dynamic_range_compression of this DolbyDigitalPreprocessing.
It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression. The values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.
- Returns
The dynamic_range_compression of this DolbyDigitalPreprocessing.
- Return type
- property lfe_low_pass_filter
Gets the lfe_low_pass_filter of this DolbyDigitalPreprocessing.
It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel. This is only allowed if the channelLayout contains a LFE channel.
- Returns
The lfe_low_pass_filter of this DolbyDigitalPreprocessing.
- Return type
- property ninety_degree_phase_shift
Gets the ninety_degree_phase_shift of this DolbyDigitalPreprocessing.
- Returns
The ninety_degree_phase_shift of this DolbyDigitalPreprocessing.
- Return type
- property openapi_types
- property three_db_attenuation
Gets the three_db_attenuation of this DolbyDigitalPreprocessing.
- Returns
The three_db_attenuation of this DolbyDigitalPreprocessing.
- Return type
bitmovin_api_sdk.models.dolby_digital_surround_mix_level module
bitmovin_api_sdk.models.dolby_digital_surround_mode module
bitmovin_api_sdk.models.dolby_digital_three_db_attenuation module
bitmovin_api_sdk.models.dolby_vision_input_stream module
- class bitmovin_api_sdk.models.dolby_vision_input_stream.DolbyVisionInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property input_id
Gets the input_id of this DolbyVisionInputStream.
Id of input (required)
- Returns
The input_id of this DolbyVisionInputStream.
- Return type
string_types
- property metadata_input_path
Gets the metadata_input_path of this DolbyVisionInputStream.
Path to Dolby Vision Metadata file. This field is required when the metadata is not embedded in the video input file.
- Returns
The metadata_input_path of this DolbyVisionInputStream.
- Return type
string_types
- property openapi_types
- property video_input_path
Gets the video_input_path of this DolbyVisionInputStream.
Path to Dolby Vision input video file. (required)
- Returns
The video_input_path of this DolbyVisionInputStream.
- Return type
string_types
bitmovin_api_sdk.models.dolby_vision_metadata module
- class bitmovin_api_sdk.models.dolby_vision_metadata.DolbyVisionMetadata(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property metadata_input_stream_id
Gets the metadata_input_stream_id of this DolbyVisionMetadata.
ID of the Dolby Vision Metadata Ingest Input Stream which provides the XML Metadata file. Required if metadataSource is set to INPUT_STREAM.
- Returns
The metadata_input_stream_id of this DolbyVisionMetadata.
- Return type
string_types
- property metadata_source
Gets the metadata_source of this DolbyVisionMetadata.
Dolby Vision Metadata Source (required)
- Returns
The metadata_source of this DolbyVisionMetadata.
- Return type
- property openapi_types
- property profile
Gets the profile of this DolbyVisionMetadata.
Dolby Vision Profile (required)
- Returns
The profile of this DolbyVisionMetadata.
- Return type
bitmovin_api_sdk.models.dolby_vision_metadata_ingest_input_stream module
- class bitmovin_api_sdk.models.dolby_vision_metadata_ingest_input_stream.DolbyVisionMetadataIngestInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property input_id
Gets the input_id of this DolbyVisionMetadataIngestInputStream.
Id of input (required)
- Returns
The input_id of this DolbyVisionMetadataIngestInputStream.
- Return type
string_types
- property input_path
Gets the input_path of this DolbyVisionMetadataIngestInputStream.
Path to Dolby Vision Metadata file (required)
- Returns
The input_path of this DolbyVisionMetadataIngestInputStream.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.dolby_vision_metadata_source module
bitmovin_api_sdk.models.dolby_vision_muxing_configuration module
- class bitmovin_api_sdk.models.dolby_vision_muxing_configuration.DolbyVisionMuxingConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property track_sample_entry_name
Gets the track_sample_entry_name of this DolbyVisionMuxingConfiguration.
- Returns
The track_sample_entry_name of this DolbyVisionMuxingConfiguration.
- Return type
bitmovin_api_sdk.models.dolby_vision_per_stream_mode module
bitmovin_api_sdk.models.dolby_vision_profile module
bitmovin_api_sdk.models.dolby_vision_track_sample_entry_name module
bitmovin_api_sdk.models.domain module
bitmovin_api_sdk.models.domain_list module
bitmovin_api_sdk.models.drm module
- class bitmovin_api_sdk.models.drm.Drm(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- discriminator_value_class_map = {'AES': 'AesEncryptionDrm', 'CENC': 'CencDrm', 'CLEARKEY': 'ClearKeyDrm', 'FAIRPLAY': 'FairPlayDrm', 'MARLIN': 'MarlinDrm', 'PLAYREADY': 'PlayReadyDrm', 'PRIMETIME': 'PrimeTimeDrm', 'SPEKE': 'SpekeDrm', 'WIDEVINE': 'WidevineDrm'}
- property openapi_types
- property outputs
Gets the outputs of this Drm.
- Returns
The outputs of this Drm.
- Return type
list[EncodingOutput]
bitmovin_api_sdk.models.drm_type module
bitmovin_api_sdk.models.dts_audio_configuration module
- class bitmovin_api_sdk.models.dts_audio_configuration.DtsAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property mode
Gets the mode of this DtsAudioConfiguration.
There are two DTS modes available: DTS Express Audio (EXPRESS_AUDIO) and DTS Digital Surround (DIGITAL_SURROUND)
- Returns
The mode of this DtsAudioConfiguration.
- Return type
- property openapi_types
bitmovin_api_sdk.models.dts_mode module
bitmovin_api_sdk.models.dts_passthrough_audio_configuration module
bitmovin_api_sdk.models.dts_x_audio_configuration module
- class bitmovin_api_sdk.models.dts_x_audio_configuration.DtsXAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this DtsXAudioConfiguration.
- Returns
The channel_layout of this DtsXAudioConfiguration.
- Return type
- property lkfs_value
Gets the lkfs_value of this DtsXAudioConfiguration.
Loudness relative to full scale (K-weighted).
- Returns
The lkfs_value of this DtsXAudioConfiguration.
- Return type
float
- property openapi_types
- property ott_loudness_mode
Gets the ott_loudness_mode of this DtsXAudioConfiguration.
- Returns
The ott_loudness_mode of this DtsXAudioConfiguration.
- Return type
- property sync_interval
Gets the sync_interval of this DtsXAudioConfiguration.
Specifies the sync interval which ranges from 1 to 10
- Returns
The sync_interval of this DtsXAudioConfiguration.
- Return type
int
bitmovin_api_sdk.models.dts_x_channel_layout module
bitmovin_api_sdk.models.dvb_subtitle_configuration module
bitmovin_api_sdk.models.dvb_subtitle_input_stream module
- class bitmovin_api_sdk.models.dvb_subtitle_input_stream.DvbSubtitleInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property input_id
Gets the input_id of this DvbSubtitleInputStream.
ID of an Input resource defining the input storage
- Returns
The input_id of this DvbSubtitleInputStream.
- Return type
string_types
- property input_path
Gets the input_path of this DvbSubtitleInputStream.
Path to an input media file
- Returns
The input_path of this DvbSubtitleInputStream.
- Return type
string_types
- property openapi_types
- property position
Gets the position of this DvbSubtitleInputStream.
Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode ‘AUTO’, defaults to 0 for any other selectionMode.
- Returns
The position of this DvbSubtitleInputStream.
- Return type
int
- property selection_mode
Gets the selection_mode of this DvbSubtitleInputStream.
Specifies the strategy for selecting a stream from the input file. Supported values for VOD encodings: AUTO, POSITION_ABSOLUTE, SUBTITLE_RELATIVE. Supported values for LIVE encodings: POSITION_ABSOLUTE
- Returns
The selection_mode of this DvbSubtitleInputStream.
- Return type
bitmovin_api_sdk.models.eac3_audio_configuration module
- class bitmovin_api_sdk.models.eac3_audio_configuration.Eac3AudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this Eac3AudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this Eac3AudioConfiguration.
- Return type
- property cutoff_frequency
Gets the cutoff_frequency of this Eac3AudioConfiguration.
The highest frequency that will pass the audio encoder. This value is optional.
- Returns
The cutoff_frequency of this Eac3AudioConfiguration.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.ebu_r128_single_pass_filter module
- class bitmovin_api_sdk.models.ebu_r128_single_pass_filter.EbuR128SinglePassFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property integrated_loudness
Gets the integrated_loudness of this EbuR128SinglePassFilter.
Set the targeted integrated loudness value. Range is from ‘-70.0’ to ‘-5.0’. Default value is ‘-24.0’. Value is measured in LUFS (Loudness Units, referenced to Full Scale)
- Returns
The integrated_loudness of this EbuR128SinglePassFilter.
- Return type
float
- property loudness_range
Gets the loudness_range of this EbuR128SinglePassFilter.
Set the targeted loudness range target. Range is from ‘1.0’ to ‘20.0’. Default value is ‘7.0’. Loudness range measures the variation of loudness on a macroscopic time-scale in units of LU (Loudness Units). For programmes shorter than 1 minute, the use of the measure Loudness Range is not recommended due to too few data points (Loudness Range is based on the Short-term-Loudness values (3-seconds-window)).
- Returns
The loudness_range of this EbuR128SinglePassFilter.
- Return type
float
- property maximum_true_peak_level
Gets the maximum_true_peak_level of this EbuR128SinglePassFilter.
Set maximum true peak. Range is from ‘-9.0’ to ‘0.0’. Default value is ‘-2.0’. Values are measured in dBTP (db True Peak)
- Returns
The maximum_true_peak_level of this EbuR128SinglePassFilter.
- Return type
float
- property openapi_types
bitmovin_api_sdk.models.egress_category module
bitmovin_api_sdk.models.egress_information module
- class bitmovin_api_sdk.models.egress_information.EgressInformation(**kwargs)[source]
Bases:
object- property attribute_map
- property bytes
Gets the bytes of this EgressInformation.
The number of bytes that have been transferred to the output (required)
- Returns
The bytes of this EgressInformation.
- Return type
int
- property category
Gets the category of this EgressInformation.
- Returns
The category of this EgressInformation.
- Return type
- property openapi_types
- property output_region
Gets the output_region of this EgressInformation.
- Returns
The output_region of this EgressInformation.
- Return type
- property output_type
Gets the output_type of this EgressInformation.
- Returns
The output_type of this EgressInformation.
- Return type
bitmovin_api_sdk.models.email_notification module
bitmovin_api_sdk.models.email_notification_with_stream_conditions module
- class bitmovin_api_sdk.models.email_notification_with_stream_conditions.EmailNotificationWithStreamConditions(**kwargs)[source]
Bases:
EmailNotification- property attribute_map
- property conditions
Gets the conditions of this EmailNotificationWithStreamConditions.
- Returns
The conditions of this EmailNotificationWithStreamConditions.
- Return type
- property openapi_types
bitmovin_api_sdk.models.email_notification_with_stream_conditions_request module
- class bitmovin_api_sdk.models.email_notification_with_stream_conditions_request.EmailNotificationWithStreamConditionsRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property conditions
Gets the conditions of this EmailNotificationWithStreamConditionsRequest.
- Returns
The conditions of this EmailNotificationWithStreamConditionsRequest.
- Return type
- property emails
Gets the emails of this EmailNotificationWithStreamConditionsRequest.
- Returns
The emails of this EmailNotificationWithStreamConditionsRequest.
- Return type
list[string_types]
- property muted
Gets the muted of this EmailNotificationWithStreamConditionsRequest.
- Returns
The muted of this EmailNotificationWithStreamConditionsRequest.
- Return type
bool
- property openapi_types
- property resolve
Gets the resolve of this EmailNotificationWithStreamConditionsRequest.
Notify when condition resolves after it was met
- Returns
The resolve of this EmailNotificationWithStreamConditionsRequest.
- Return type
bool
bitmovin_api_sdk.models.encoding module
- class bitmovin_api_sdk.models.encoding.Encoding(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property cloud_region
Gets the cloud_region of this Encoding.
- Returns
The cloud_region of this Encoding.
- Return type
- property encoder_version
Gets the encoder_version of this Encoding.
Version of the encoder
- Returns
The encoder_version of this Encoding.
- Return type
string_types
- property error_at
Gets the error_at of this Encoding.
Timestamp when the encoding status changed to ‘ERROR’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an ‘ERROR’.
- Returns
The error_at of this Encoding.
- Return type
datetime
- property fallback_cloud_regions
Gets the fallback_cloud_regions of this Encoding.
Specify a list of regions which are used in case the preferred region is down. Currently there are several restrictions. - The region has to be specific or AUTO - The region has to be for the same cloud provider as the default one - You can only configure at most 3 fallback regions
- Returns
The fallback_cloud_regions of this Encoding.
- Return type
list[CloudRegion]
- property finished_at
Gets the finished_at of this Encoding.
Timestamp when the encoding status changed to ‘FINISHED’, ‘ERROR’, ‘CANCELED’, or ‘TRANSFER_ERROR’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for encodings which ran prior to the [1.50.0 REST API release](https://bitmovin.com/docs/encoding/changelogs/rest).
- Returns
The finished_at of this Encoding.
- Return type
datetime
- property infrastructure
Gets the infrastructure of this Encoding.
- Returns
The infrastructure of this Encoding.
- Return type
- property labels
Gets the labels of this Encoding.
You may pass a list of groups associated with this encoding. This will enable you to group results in the statistics resource
- Returns
The labels of this Encoding.
- Return type
list[string_types]
- property live_options_type
Gets the live_options_type of this Encoding.
The chosen live option type of the live encoding
- Returns
The live_options_type of this Encoding.
- Return type
- property openapi_types
- property progress
Gets the progress of this Encoding.
Progress of the encoding in percent
- Returns
The progress of this Encoding.
- Return type
int
- property queued_at
Gets the queued_at of this Encoding.
Timestamp when the encoding status changed to “QUEUED”, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The queued_at of this Encoding.
- Return type
datetime
- property running_at
Gets the running_at of this Encoding.
Timestamp when the encoding status changed to “RUNNING”, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The running_at of this Encoding.
- Return type
datetime
- property selected_cloud_region
Gets the selected_cloud_region of this Encoding.
After the encoding has been started, this will contain the cloud region that was actually used. This will differ from cloudRegion if cloudRegion was set to an unspecific region (e.g. ‘AUTO’)
- Returns
The selected_cloud_region of this Encoding.
- Return type
- property selected_encoder_version
Gets the selected_encoder_version of this Encoding.
After the encoding has been started, this will contain the encoder version that was actually used. Especially useful when starting an encoding with a version tag like STABLE or BETA.
- Returns
The selected_encoder_version of this Encoding.
- Return type
string_types
- property selected_encoding_mode
Gets the selected_encoding_mode of this Encoding.
After the encoding has been started, this will contain the encoding mode that was actually used. Especially useful when encodingMode was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).
- Returns
The selected_encoding_mode of this Encoding.
- Return type
- property selected_fallback_cloud_regions
Gets the selected_fallback_cloud_regions of this Encoding.
After the encoding has been started, this will contain the fallback cloud regions that were actually used. This will differ from fallbackCloudRegions if any of the fallbackCloudRegions were set to an unspecific region (e.g. ‘AUTO’)
- Returns
The selected_fallback_cloud_regions of this Encoding.
- Return type
list[CloudRegion]
- property started_at
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
- Returns
The started_at of this Encoding.
- Return type
datetime
- property static_ip_id
Gets the static_ip_id of this Encoding.
Specify an ID of a Static IP infrastructure resource this encoding should use. A Static IP cannot be used by multiple encodings at once. The encoding will go to an error state if the Static IP is already in use. This is currently only supported for live encodings.
- Returns
The static_ip_id of this Encoding.
- Return type
string_types
- property status
Gets the status of this Encoding.
The current status of the encoding.
- Returns
The status of this Encoding.
- Return type
- property type
Gets the type of this Encoding.
Type of the encoding
- Returns
The type of this Encoding.
- Return type
bitmovin_api_sdk.models.encoding_error_definition module
- class bitmovin_api_sdk.models.encoding_error_definition.EncodingErrorDefinition(**kwargs)[source]
Bases:
object- property attribute_map
- property category
Gets the category of this EncodingErrorDefinition.
The error category.
- Returns
The category of this EncodingErrorDefinition.
- Return type
string_types
- property code
Gets the code of this EncodingErrorDefinition.
The error code.
- Returns
The code of this EncodingErrorDefinition.
- Return type
int
- property description
Gets the description of this EncodingErrorDefinition.
The returned error description.
- Returns
The description of this EncodingErrorDefinition.
- Return type
string_types
- property message
Gets the message of this EncodingErrorDefinition.
The error message, optional. Can include placeholders like {1}, {2} which are replaced with the respective dependency when the error is thrown.
- Returns
The message of this EncodingErrorDefinition.
- Return type
string_types
- property openapi_types
- property retry_hint
Gets the retry_hint of this EncodingErrorDefinition.
Indicates if the call that caused the error should be retried.
- Returns
The retry_hint of this EncodingErrorDefinition.
- Return type
bitmovin_api_sdk.models.encoding_error_email_notification module
bitmovin_api_sdk.models.encoding_mode module
bitmovin_api_sdk.models.encoding_output module
- class bitmovin_api_sdk.models.encoding_output.EncodingOutput(**kwargs)[source]
Bases:
object- property acl
Gets the acl of this EncodingOutput.
Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL
- Returns
The acl of this EncodingOutput.
- Return type
list[AclEntry]
- property attribute_map
- property openapi_types
- property output_id
Gets the output_id of this EncodingOutput.
Id of the corresponding output (required)
- Returns
The output_id of this EncodingOutput.
- Return type
string_types
- property output_path
Gets the output_path of this EncodingOutput.
Subdirectory where to save the files to (required)
- Returns
The output_path of this EncodingOutput.
- Return type
string_types
bitmovin_api_sdk.models.encoding_output_paths module
- class bitmovin_api_sdk.models.encoding_output_paths.EncodingOutputPaths(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property output
Gets the output of this EncodingOutputPaths.
- Returns
The output of this EncodingOutputPaths.
- Return type
- property paths
Gets the paths of this EncodingOutputPaths.
- Returns
The paths of this EncodingOutputPaths.
- Return type
bitmovin_api_sdk.models.encoding_output_paths_dash_manifest module
- class bitmovin_api_sdk.models.encoding_output_paths_dash_manifest.EncodingOutputPathsDashManifest(**kwargs)[source]
Bases:
object- property attribute_map
- property id
Gets the id of this EncodingOutputPathsDashManifest.
Id of the dash manifest
- Returns
The id of this EncodingOutputPathsDashManifest.
- Return type
string_types
- property openapi_types
- property path
Gets the path of this EncodingOutputPathsDashManifest.
Path to the dash manifest on the given output
- Returns
The path of this EncodingOutputPathsDashManifest.
- Return type
string_types
bitmovin_api_sdk.models.encoding_output_paths_for_output module
- class bitmovin_api_sdk.models.encoding_output_paths_for_output.EncodingOutputPathsForOutput(**kwargs)[source]
Bases:
object- property attribute_map
- property dash_manifests
Gets the dash_manifests of this EncodingOutputPathsForOutput.
Output paths for Dash manifests
- Returns
The dash_manifests of this EncodingOutputPathsForOutput.
- Return type
- property hls_manifests
Gets the hls_manifests of this EncodingOutputPathsForOutput.
Output paths for HLS manifests
- Returns
The hls_manifests of this EncodingOutputPathsForOutput.
- Return type
- property openapi_types
- property smooth_manifests
Gets the smooth_manifests of this EncodingOutputPathsForOutput.
Output paths for Smooth manifests
- Returns
The smooth_manifests of this EncodingOutputPathsForOutput.
- Return type
bitmovin_api_sdk.models.encoding_output_paths_hls_manifest module
- class bitmovin_api_sdk.models.encoding_output_paths_hls_manifest.EncodingOutputPathsHlsManifest(**kwargs)[source]
Bases:
object- property attribute_map
- property id
Gets the id of this EncodingOutputPathsHlsManifest.
Id of the HLS manifest
- Returns
The id of this EncodingOutputPathsHlsManifest.
- Return type
string_types
- property openapi_types
- property path
Gets the path of this EncodingOutputPathsHlsManifest.
Path to the index file of the HLS manifest on the given output
- Returns
The path of this EncodingOutputPathsHlsManifest.
- Return type
string_types
bitmovin_api_sdk.models.encoding_output_paths_smooth_manifest module
- class bitmovin_api_sdk.models.encoding_output_paths_smooth_manifest.EncodingOutputPathsSmoothManifest(**kwargs)[source]
Bases:
object- property attribute_map
- property client_manifest_path
Gets the client_manifest_path of this EncodingOutputPathsSmoothManifest.
Path to the client manifest of the Smooth manifest on the given output
- Returns
The client_manifest_path of this EncodingOutputPathsSmoothManifest.
- Return type
string_types
- property id
Gets the id of this EncodingOutputPathsSmoothManifest.
Id of the Smooth manifest
- Returns
The id of this EncodingOutputPathsSmoothManifest.
- Return type
string_types
- property openapi_types
- property server_manifest_path
Gets the server_manifest_path of this EncodingOutputPathsSmoothManifest.
Path to the server manifest of the Smooth manifest on the given output
- Returns
The server_manifest_path of this EncodingOutputPathsSmoothManifest.
- Return type
string_types
bitmovin_api_sdk.models.encoding_statistics module
- class bitmovin_api_sdk.models.encoding_statistics.EncodingStatistics(**kwargs)[source]
Bases:
object- property attribute_map
- property billable_egress_bytes
Gets the billable_egress_bytes of this EncodingStatistics.
- Returns
The billable_egress_bytes of this EncodingStatistics.
- Return type
list[EgressInformation]
- property billable_encoding_minutes
Gets the billable_encoding_minutes of this EncodingStatistics.
- Returns
The billable_encoding_minutes of this EncodingStatistics.
- Return type
list[BillableEncodingMinutes]
- property billable_feature_minutes
Gets the billable_feature_minutes of this EncodingStatistics.
Billable minutes for the features.
- Returns
The billable_feature_minutes of this EncodingStatistics.
- Return type
float
- property billable_transmuxing_minutes
Gets the billable_transmuxing_minutes of this EncodingStatistics.
Billable minutes for the muxings.
- Returns
The billable_transmuxing_minutes of this EncodingStatistics.
- Return type
float
- property bytes_egress
Gets the bytes_egress of this EncodingStatistics.
Egress output generated by file transfers in bytes (required)
- Returns
The bytes_egress of this EncodingStatistics.
- Return type
int
- property bytes_encoded
Gets the bytes_encoded of this EncodingStatistics.
Bytes encoded for this encoding. (required)
- Returns
The bytes_encoded of this EncodingStatistics.
- Return type
int
- property date
Gets the date of this EncodingStatistics.
Date, format. yyyy-MM-dd (required)
- Returns
The date of this EncodingStatistics.
- Return type
date
- property features
Gets the features of this EncodingStatistics.
- Returns
The features of this EncodingStatistics.
- Return type
- property muxings
Gets the muxings of this EncodingStatistics.
- Returns
The muxings of this EncodingStatistics.
- Return type
list[StatisticsPerMuxing]
- property openapi_types
- property streams
Gets the streams of this EncodingStatistics.
- Returns
The streams of this EncodingStatistics.
- Return type
list[StatisticsPerStream]
- property time_encoded
Gets the time_encoded of this EncodingStatistics.
Time in seconds encoded for this encoding. (required)
- Returns
The time_encoded of this EncodingStatistics.
- Return type
int
bitmovin_api_sdk.models.encoding_statistics_live module
bitmovin_api_sdk.models.encoding_statistics_vod module
- class bitmovin_api_sdk.models.encoding_statistics_vod.EncodingStatisticsVod(**kwargs)[source]
Bases:
EncodingStatistics- property attribute_map
- property openapi_types
- property realtime_factor
Gets the realtime_factor of this EncodingStatisticsVod.
The realtime factor. (required)
- Returns
The realtime_factor of this EncodingStatisticsVod.
- Return type
float
- property time_enqueued
Gets the time_enqueued of this EncodingStatisticsVod.
Time in seconds encoded for this encoding. (required)
- Returns
The time_enqueued of this EncodingStatisticsVod.
- Return type
int
bitmovin_api_sdk.models.encoding_stats module
- class bitmovin_api_sdk.models.encoding_stats.EncodingStats(**kwargs)[source]
Bases:
object- property attribute_map
- property billable_egress_bytes
Gets the billable_egress_bytes of this EncodingStats.
Billable egress output
- Returns
The billable_egress_bytes of this EncodingStats.
- Return type
list[EgressInformation]
- property billable_encoding_minutes
Gets the billable_encoding_minutes of this EncodingStats.
Detailed statistics per stream
- Returns
The billable_encoding_minutes of this EncodingStats.
- Return type
list[BillableEncodingMinutes]
- property billable_feature_minutes
Gets the billable_feature_minutes of this EncodingStats.
Billable feature minutes
- Returns
The billable_feature_minutes of this EncodingStats.
- Return type
float
- property billable_minutes
Gets the billable_minutes of this EncodingStats.
Billable minutes
- Returns
The billable_minutes of this EncodingStats.
- Return type
float
- property billable_transmuxing_minutes
Gets the billable_transmuxing_minutes of this EncodingStats.
Billable transmuxing minutes (required)
- Returns
The billable_transmuxing_minutes of this EncodingStats.
- Return type
float
- property bytes_encoded
Gets the bytes_encoded of this EncodingStats.
Total bytes encoded
- Returns
The bytes_encoded of this EncodingStats.
- Return type
int
- property date
Gets the date of this EncodingStats.
Date, format. yyyy-MM-dd
- Returns
The date of this EncodingStats.
- Return type
date
- property downloaded_size
Gets the downloaded_size of this EncodingStats.
Downloaded size of the input file
- Returns
The downloaded_size of this EncodingStats.
- Return type
int
- property encoding_id
Gets the encoding_id of this EncodingStats.
The id of the encoding (required)
- Returns
The encoding_id of this EncodingStats.
- Return type
string_types
- property features
Gets the features of this EncodingStats.
Detailed statistics per feature
- Returns
The features of this EncodingStats.
- Return type
- property muxings
Gets the muxings of this EncodingStats.
Detailed statistics per muxing (required)
- Returns
The muxings of this EncodingStats.
- Return type
list[StatisticsPerMuxing]
- property openapi_types
- property streams
Gets the streams of this EncodingStats.
Detailed statistics per stream (required)
- Returns
The streams of this EncodingStats.
- Return type
list[StatisticsPerStream]
- property time_encoded
Gets the time_encoded of this EncodingStats.
Total time encoded
- Returns
The time_encoded of this EncodingStats.
- Return type
int
bitmovin_api_sdk.models.encoding_stream_input module
- class bitmovin_api_sdk.models.encoding_stream_input.EncodingStreamInput(**kwargs)[source]
Bases:
object- property attribute_map
- property details
Gets the details of this EncodingStreamInput.
- Returns
The details of this EncodingStreamInput.
- Return type
- property input_id
Gets the input_id of this EncodingStreamInput.
Input id (required)
- Returns
The input_id of this EncodingStreamInput.
- Return type
string_types
- property input_path
Gets the input_path of this EncodingStreamInput.
Path to media file (required)
- Returns
The input_path of this EncodingStreamInput.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.encoding_stream_input_details module
- class bitmovin_api_sdk.models.encoding_stream_input_details.EncodingStreamInputDetails(**kwargs)[source]
Bases:
object- property attribute_map
- property audio_streams
Gets the audio_streams of this EncodingStreamInputDetails.
Audio stream in the input file
- Returns
The audio_streams of this EncodingStreamInputDetails.
- Return type
list[AudioStream]
- property bitrate
Gets the bitrate of this EncodingStreamInputDetails.
Bitrate in bps
- Returns
The bitrate of this EncodingStreamInputDetails.
- Return type
int
- property duration
Gets the duration of this EncodingStreamInputDetails.
Duration in seconds
- Returns
The duration of this EncodingStreamInputDetails.
- Return type
float
- property format_name
Gets the format_name of this EncodingStreamInputDetails.
Format name
- Returns
The format_name of this EncodingStreamInputDetails.
- Return type
string_types
- property meta_streams
Gets the meta_streams of this EncodingStreamInputDetails.
Meta data streams in the input file
- Returns
The meta_streams of this EncodingStreamInputDetails.
- Return type
list[MediaStream]
- property openapi_types
- property size
Gets the size of this EncodingStreamInputDetails.
Input file size in bytes
- Returns
The size of this EncodingStreamInputDetails.
- Return type
int
- property start_time
Gets the start_time of this EncodingStreamInputDetails.
The start time in seconds
- Returns
The start_time of this EncodingStreamInputDetails.
- Return type
float
- property subtitle_streams
Gets the subtitle_streams of this EncodingStreamInputDetails.
Subtitle streams in the input file
- Returns
The subtitle_streams of this EncodingStreamInputDetails.
- Return type
list[SubtitleStream]
- property tags
Gets the tags of this EncodingStreamInputDetails.
Additional metadata saved in the input file
- Returns
The tags of this EncodingStreamInputDetails.
- Return type
dict(str, object)
- property video_streams
Gets the video_streams of this EncodingStreamInputDetails.
Video streams in the input file
- Returns
The video_streams of this EncodingStreamInputDetails.
- Return type
list[VideoStream]
bitmovin_api_sdk.models.encoding_template module
bitmovin_api_sdk.models.encoding_template_details module
- class bitmovin_api_sdk.models.encoding_template_details.EncodingTemplateDetails(**kwargs)[source]
Bases:
EncodingTemplateResponse- property attribute_map
- property openapi_types
- property url
Gets the url of this EncodingTemplateDetails.
The url to download the template file (required)
- Returns
The url of this EncodingTemplateDetails.
- Return type
string_types
bitmovin_api_sdk.models.encoding_template_request module
bitmovin_api_sdk.models.encoding_template_response module
bitmovin_api_sdk.models.encoding_template_start_response module
- class bitmovin_api_sdk.models.encoding_template_start_response.EncodingTemplateStartResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property encoding_id
Gets the encoding_id of this EncodingTemplateStartResponse.
Id of the Encoding that is created (required)
- Returns
The encoding_id of this EncodingTemplateStartResponse.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.encoding_template_type module
bitmovin_api_sdk.models.encoding_type module
bitmovin_api_sdk.models.encryption_mode module
bitmovin_api_sdk.models.enhanced_deinterlace_auto_enable module
bitmovin_api_sdk.models.enhanced_deinterlace_filter module
- class bitmovin_api_sdk.models.enhanced_deinterlace_filter.EnhancedDeinterlaceFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property auto_enable
Gets the auto_enable of this EnhancedDeinterlaceFilter.
- Returns
The auto_enable of this EnhancedDeinterlaceFilter.
- Return type
- property mode
Gets the mode of this EnhancedDeinterlaceFilter.
- Returns
The mode of this EnhancedDeinterlaceFilter.
- Return type
- property openapi_types
- property parity
Gets the parity of this EnhancedDeinterlaceFilter.
- Returns
The parity of this EnhancedDeinterlaceFilter.
- Return type
bitmovin_api_sdk.models.enhanced_deinterlace_mode module
bitmovin_api_sdk.models.enhanced_deinterlace_parity module
bitmovin_api_sdk.models.enhanced_watermark_filter module
- class bitmovin_api_sdk.models.enhanced_watermark_filter.EnhancedWatermarkFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property bottom
Gets the bottom of this EnhancedWatermarkFilter.
Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if ‘top’ is set.
- Returns
The bottom of this EnhancedWatermarkFilter.
- Return type
float
- property height
Gets the height of this EnhancedWatermarkFilter.
Desired height of the watermark image, the unit of the parameter is specified separately by the parameter ‘unit’. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it
- Returns
The height of this EnhancedWatermarkFilter.
- Return type
float
- property image
Gets the image of this EnhancedWatermarkFilter.
URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)
- Returns
The image of this EnhancedWatermarkFilter.
- Return type
string_types
- property left
Gets the left of this EnhancedWatermarkFilter.
Distance from the left edge of the input video to the left edge of the watermark image. May not be set if ‘right’ is set.
- Returns
The left of this EnhancedWatermarkFilter.
- Return type
float
- property opacity
Gets the opacity of this EnhancedWatermarkFilter.
Opacity to apply on the watermark image. Valid values are from 0.0 (completely transparent) to 1.0 (not transparent at all)
- Returns
The opacity of this EnhancedWatermarkFilter.
- Return type
float
- property openapi_types
- property right
Gets the right of this EnhancedWatermarkFilter.
Distance from the right edge of the input video to the right edge of the watermark image . May not be set if ‘left’ is set.
- Returns
The right of this EnhancedWatermarkFilter.
- Return type
float
- property top
Gets the top of this EnhancedWatermarkFilter.
Distance from the top edge of the input video to the top edge of the watermark image. May not be set if ‘bottom’ is set.
- Returns
The top of this EnhancedWatermarkFilter.
- Return type
float
- property unit
Gets the unit of this EnhancedWatermarkFilter.
- Returns
The unit of this EnhancedWatermarkFilter.
- Return type
- property width
Gets the width of this EnhancedWatermarkFilter.
Desired width of the watermark image, the unit of the parameter is specified separately by the parameter ‘unit’. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it
- Returns
The width of this EnhancedWatermarkFilter.
- Return type
float
bitmovin_api_sdk.models.error_details module
- class bitmovin_api_sdk.models.error_details.ErrorDetails(**kwargs)[source]
Bases:
object- property attribute_map
- property category
Gets the category of this ErrorDetails.
Error group name (required)
- Returns
The category of this ErrorDetails.
- Return type
string_types
- property code
Gets the code of this ErrorDetails.
Specific error code (required)
- Returns
The code of this ErrorDetails.
- Return type
int
- property openapi_types
- property retry_hint
Gets the retry_hint of this ErrorDetails.
Information if the encoding could potentially succeed when retrying. (required)
- Returns
The retry_hint of this ErrorDetails.
- Return type
- property text
Gets the text of this ErrorDetails.
Detailed error message (required)
- Returns
The text of this ErrorDetails.
- Return type
string_types
bitmovin_api_sdk.models.error_retry_hint module
bitmovin_api_sdk.models.external_id_mode module
bitmovin_api_sdk.models.fair_play_drm module
- class bitmovin_api_sdk.models.fair_play_drm.FairPlayDrm(**kwargs)[source]
Bases:
Drm- property attribute_map
- property iv
Gets the iv of this FairPlayDrm.
16 byte initialization vector (required)
- Returns
The iv of this FairPlayDrm.
- Return type
string_types
- property key
Gets the key of this FairPlayDrm.
16 byte Encryption key, 32 hexadecimal characters (required)
- Returns
The key of this FairPlayDrm.
- Return type
string_types
- property openapi_types
- property uri
Gets the uri of this FairPlayDrm.
Url of the licensing server
- Returns
The uri of this FairPlayDrm.
- Return type
string_types
bitmovin_api_sdk.models.file_input_stream module
- class bitmovin_api_sdk.models.file_input_stream.FileInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property file_type
Gets the file_type of this FileInputStream.
- Returns
The file_type of this FileInputStream.
- Return type
- property input_id
Gets the input_id of this FileInputStream.
Id of input (required)
- Returns
The input_id of this FileInputStream.
- Return type
string_types
- property input_path
Gets the input_path of this FileInputStream.
Path to file (required)
- Returns
The input_path of this FileInputStream.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.file_input_stream_type module
bitmovin_api_sdk.models.filter module
- class bitmovin_api_sdk.models.filter.Filter(**kwargs)[source]
Bases:
BitmovinResource- discriminator_value_class_map = {'AUDIO_MIX': 'AudioMixFilter', 'AUDIO_VOLUME': 'AudioVolumeFilter', 'AZURE_SPEECH_TO_CAPTIONS': 'AzureSpeechToCaptionsFilter', 'CONFORM': 'ConformFilter', 'CROP': 'CropFilter', 'DEINTERLACE': 'DeinterlaceFilter', 'DENOISE_HQDN3D': 'DenoiseHqdn3dFilter', 'EBU_R128_SINGLE_PASS': 'EbuR128SinglePassFilter', 'ENHANCED_DEINTERLACE': 'EnhancedDeinterlaceFilter', 'ENHANCED_WATERMARK': 'EnhancedWatermarkFilter', 'INTERLACE': 'InterlaceFilter', 'ROTATE': 'RotateFilter', 'SCALE': 'ScaleFilter', 'TEXT': 'TextFilter', 'UNSHARP': 'UnsharpFilter', 'WATERMARK': 'WatermarkFilter'}
bitmovin_api_sdk.models.filter_type module
- class bitmovin_api_sdk.models.filter_type.FilterType(value)[source]
Bases:
EnumAn enumeration.
- AUDIO_MIX = 'AUDIO_MIX'
- AUDIO_VOLUME = 'AUDIO_VOLUME'
- AZURE_SPEECH_TO_CAPTIONS = 'AZURE_SPEECH_TO_CAPTIONS'
- CONFORM = 'CONFORM'
- CROP = 'CROP'
- DEINTERLACE = 'DEINTERLACE'
- DENOISE_HQDN3D = 'DENOISE_HQDN3D'
- EBU_R128_SINGLE_PASS = 'EBU_R128_SINGLE_PASS'
- ENHANCED_DEINTERLACE = 'ENHANCED_DEINTERLACE'
- ENHANCED_WATERMARK = 'ENHANCED_WATERMARK'
- INTERLACE = 'INTERLACE'
- ROTATE = 'ROTATE'
- SCALE = 'SCALE'
- TEXT = 'TEXT'
- UNSHARP = 'UNSHARP'
- WATERMARK = 'WATERMARK'
bitmovin_api_sdk.models.fmp4_muxing module
- class bitmovin_api_sdk.models.fmp4_muxing.Fmp4Muxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property init_segment_name
Gets the init_segment_name of this Fmp4Muxing.
Init segment name
- Returns
The init_segment_name of this Fmp4Muxing.
- Return type
string_types
- property init_segment_name_template
Gets the init_segment_name_template of this Fmp4Muxing.
Segment naming policy containing a placeholder of the format ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.
- Returns
The init_segment_name_template of this Fmp4Muxing.
- Return type
string_types
- property openapi_types
- property pts_align_mode
Gets the pts_align_mode of this Fmp4Muxing.
Alignment mode for composition / presentation timestamps (CTS/PTS). Only applies to h.264 and h.265
- Returns
The pts_align_mode of this Fmp4Muxing.
- Return type
- property segment_length
Gets the segment_length of this Fmp4Muxing.
Length of the fragments in seconds (required)
- Returns
The segment_length of this Fmp4Muxing.
- Return type
float
- property segment_naming
Gets the segment_naming of this Fmp4Muxing.
Segment naming policy
- Returns
The segment_naming of this Fmp4Muxing.
- Return type
string_types
- property segment_naming_template
Gets the segment_naming_template of this Fmp4Muxing.
Segment naming policy containing one or both of the following placeholders: - ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - ‘{segment_rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.
- Returns
The segment_naming_template of this Fmp4Muxing.
- Return type
string_types
- property segments_muxed
Gets the segments_muxed of this Fmp4Muxing.
Number of segments which have been encoded
- Returns
The segments_muxed of this Fmp4Muxing.
- Return type
int
- property write_duration_per_sample
Gets the write_duration_per_sample of this Fmp4Muxing.
Writes the duration per sample into the sample entry in the Track Fragment Run Box. This could help to fix playback issues on legacy players. Enabling this flag increases the muxing overhead by 4 bytes per sample/frame.
- Returns
The write_duration_per_sample of this Fmp4Muxing.
- Return type
bool
bitmovin_api_sdk.models.fmp4_muxing_information module
bitmovin_api_sdk.models.force_flush_mode module
bitmovin_api_sdk.models.fragmented_mp4_muxing_manifest_type module
- class bitmovin_api_sdk.models.fragmented_mp4_muxing_manifest_type.FragmentedMp4MuxingManifestType(value)[source]
Bases:
EnumAn enumeration.
- DASH_ON_DEMAND = 'DASH_ON_DEMAND'
- HLS_BYTE_RANGES = 'HLS_BYTE_RANGES'
- HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST = 'HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST'
- NONE = 'NONE'
- SMOOTH = 'SMOOTH'
bitmovin_api_sdk.models.fragmented_muxing_information module
- class bitmovin_api_sdk.models.fragmented_muxing_information.FragmentedMuxingInformation(**kwargs)[source]
Bases:
object- property attribute_map
- property audio_tracks
Gets the audio_tracks of this FragmentedMuxingInformation.
Information about the audio tracks in the container
- Returns
The audio_tracks of this FragmentedMuxingInformation.
- Return type
- property container_bitrate
Gets the container_bitrate of this FragmentedMuxingInformation.
The bitrate of the container if available (tracks + container overhead)
- Returns
The container_bitrate of this FragmentedMuxingInformation.
- Return type
int
- property container_format
Gets the container_format of this FragmentedMuxingInformation.
The container format used
- Returns
The container_format of this FragmentedMuxingInformation.
- Return type
string_types
- property duration
Gets the duration of this FragmentedMuxingInformation.
The duration of the container in seconds
- Returns
The duration of this FragmentedMuxingInformation.
- Return type
float
- property file_size
Gets the file_size of this FragmentedMuxingInformation.
The file size of the muxing in bytes
- Returns
The file_size of this FragmentedMuxingInformation.
- Return type
int
- property mime_type
Gets the mime_type of this FragmentedMuxingInformation.
The mime type of the muxing
- Returns
The mime_type of this FragmentedMuxingInformation.
- Return type
string_types
- property openapi_types
- property video_tracks
Gets the video_tracks of this FragmentedMuxingInformation.
Information about the video tracks in the container
- Returns
The video_tracks of this FragmentedMuxingInformation.
- Return type
bitmovin_api_sdk.models.frame_id_id3_tag module
- class bitmovin_api_sdk.models.frame_id_id3_tag.FrameIdId3Tag(**kwargs)[source]
Bases:
Id3Tag- property attribute_map
- property bytes
Gets the bytes of this FrameIdId3Tag.
Base64 Encoded Data (required)
- Returns
The bytes of this FrameIdId3Tag.
- Return type
string_types
- property frame_id
Gets the frame_id of this FrameIdId3Tag.
4 character long Frame ID (required)
- Returns
The frame_id of this FrameIdId3Tag.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.ftp_input module
- class bitmovin_api_sdk.models.ftp_input.FtpInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property host
Gets the host of this FtpInput.
Host URL or IP of the FTP server (required)
- Returns
The host of this FtpInput.
- Return type
string_types
- property openapi_types
- property passive
Gets the passive of this FtpInput.
Use passive mode. Default is true.
- Returns
The passive of this FtpInput.
- Return type
bool
- property password
Gets the password of this FtpInput.
Your FTP password
- Returns
The password of this FtpInput.
- Return type
string_types
- property port
Gets the port of this FtpInput.
Port to use, standard for FTP: 21
- Returns
The port of this FtpInput.
- Return type
int
- property remote_verification_enabled
Gets the remote_verification_enabled of this FtpInput.
Ensure that connections originate from the declared ftp host. Default is true.
- Returns
The remote_verification_enabled of this FtpInput.
- Return type
bool
- property username
Gets the username of this FtpInput.
Your FTP Username
- Returns
The username of this FtpInput.
- Return type
string_types
bitmovin_api_sdk.models.ftp_output module
- class bitmovin_api_sdk.models.ftp_output.FtpOutput(**kwargs)[source]
Bases:
Output- property attribute_map
- property host
Gets the host of this FtpOutput.
Host URL or IP of the FTP server (required)
- Returns
The host of this FtpOutput.
- Return type
string_types
- property max_concurrent_connections
Gets the max_concurrent_connections of this FtpOutput.
Restrict maximum concurrent connections. Requires at least version 1.1.0.
- Returns
The max_concurrent_connections of this FtpOutput.
- Return type
int
- property openapi_types
- property passive
Gets the passive of this FtpOutput.
Use passive mode. Default is true.
- Returns
The passive of this FtpOutput.
- Return type
bool
- property password
Gets the password of this FtpOutput.
Your FTP password
- Returns
The password of this FtpOutput.
- Return type
string_types
- property port
Gets the port of this FtpOutput.
Port to use, standard for FTP: 21
- Returns
The port of this FtpOutput.
- Return type
int
- property transfer_version
Gets the transfer_version of this FtpOutput.
Controls which transfer version should be used
- Returns
The transfer_version of this FtpOutput.
- Return type
- property username
Gets the username of this FtpOutput.
Your FTP Username
- Returns
The username of this FtpOutput.
- Return type
string_types
bitmovin_api_sdk.models.gce_account module
- class bitmovin_api_sdk.models.gce_account.GceAccount(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property openapi_types
- property private_key
Gets the private_key of this GceAccount.
Google private key of the Google service account that will be used to spin up VMs
- Returns
The private_key of this GceAccount.
- Return type
string_types
- property project_id
Gets the project_id of this GceAccount.
ID of the GCP project in which the VMs are supposed to run.
- Returns
The project_id of this GceAccount.
- Return type
string_types
- property service_account_credentials
Gets the service_account_credentials of this GceAccount.
GCP service account credentials JSON
- Returns
The service_account_credentials of this GceAccount.
- Return type
string_types
- property service_account_email
Gets the service_account_email of this GceAccount.
Email address of the Google service account that will be used to spin up VMs
- Returns
The service_account_email of this GceAccount.
- Return type
string_types
bitmovin_api_sdk.models.gce_account_region_settings module
- class bitmovin_api_sdk.models.gce_account_region_settings.GceAccountRegionSettings(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property network
Gets the network of this GceAccountRegionSettings.
Id of the network for encoding instances (required)
- Returns
The network of this GceAccountRegionSettings.
- Return type
string_types
- property openapi_types
- property region
Gets the region of this GceAccountRegionSettings.
- Returns
The region of this GceAccountRegionSettings.
- Return type
- property subnet_id
Gets the subnet_id of this GceAccountRegionSettings.
Id of the subnet for encoding instances (required)
- Returns
The subnet_id of this GceAccountRegionSettings.
- Return type
string_types
bitmovin_api_sdk.models.gcs_input module
- class bitmovin_api_sdk.models.gcs_input.GcsInput(**kwargs)[source]
Bases:
Input- property access_key
Gets the access_key of this GcsInput.
GCS access key (required)
- Returns
The access_key of this GcsInput.
- Return type
string_types
- property attribute_map
- property bucket_name
Gets the bucket_name of this GcsInput.
Name of the bucket (required)
- Returns
The bucket_name of this GcsInput.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this GcsInput.
The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.
- Returns
The cloud_region of this GcsInput.
- Return type
- property openapi_types
- property secret_key
Gets the secret_key of this GcsInput.
GCS secret key (required)
- Returns
The secret_key of this GcsInput.
- Return type
string_types
bitmovin_api_sdk.models.gcs_output module
- class bitmovin_api_sdk.models.gcs_output.GcsOutput(**kwargs)[source]
Bases:
Output- property access_key
Gets the access_key of this GcsOutput.
GCS access key (required)
- Returns
The access_key of this GcsOutput.
- Return type
string_types
- property attribute_map
- property bucket_name
Gets the bucket_name of this GcsOutput.
Name of the bucket (required)
- Returns
The bucket_name of this GcsOutput.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this GcsOutput.
The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.
- Returns
The cloud_region of this GcsOutput.
- Return type
- property openapi_types
- property secret_key
Gets the secret_key of this GcsOutput.
GCS secret key (required)
- Returns
The secret_key of this GcsOutput.
- Return type
string_types
bitmovin_api_sdk.models.gcs_service_account_input module
- class bitmovin_api_sdk.models.gcs_service_account_input.GcsServiceAccountInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property bucket_name
Gets the bucket_name of this GcsServiceAccountInput.
Name of the bucket (required)
- Returns
The bucket_name of this GcsServiceAccountInput.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this GcsServiceAccountInput.
The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.
- Returns
The cloud_region of this GcsServiceAccountInput.
- Return type
- property openapi_types
- property service_account_credentials
Gets the service_account_credentials of this GcsServiceAccountInput.
GCS projectId (required)
- Returns
The service_account_credentials of this GcsServiceAccountInput.
- Return type
string_types
bitmovin_api_sdk.models.gcs_service_account_output module
- class bitmovin_api_sdk.models.gcs_service_account_output.GcsServiceAccountOutput(**kwargs)[source]
Bases:
Output- property attribute_map
- property bucket_name
Gets the bucket_name of this GcsServiceAccountOutput.
Name of the bucket (required)
- Returns
The bucket_name of this GcsServiceAccountOutput.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this GcsServiceAccountOutput.
The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.
- Returns
The cloud_region of this GcsServiceAccountOutput.
- Return type
- property openapi_types
- property service_account_credentials
Gets the service_account_credentials of this GcsServiceAccountOutput.
GCS projectId (required)
- Returns
The service_account_credentials of this GcsServiceAccountOutput.
- Return type
string_types
bitmovin_api_sdk.models.generic_s3_input module
- class bitmovin_api_sdk.models.generic_s3_input.GenericS3Input(**kwargs)[source]
Bases:
Input- property access_key
Gets the access_key of this GenericS3Input.
Your generic S3 access key (required)
- Returns
The access_key of this GenericS3Input.
- Return type
string_types
- property access_style
Gets the access_style of this GenericS3Input.
Specifies the URL access style to use
- Returns
The access_style of this GenericS3Input.
- Return type
- property attribute_map
- property bucket_name
Gets the bucket_name of this GenericS3Input.
Your generic S3 bucket name (required)
- Returns
The bucket_name of this GenericS3Input.
- Return type
string_types
- property host
Gets the host of this GenericS3Input.
The generic S3 server hostname (or IP address) (required)
- Returns
The host of this GenericS3Input.
- Return type
string_types
- property openapi_types
- property port
Gets the port of this GenericS3Input.
The port on which the generic S3 server is running on (if not provided 8000 will be used)
- Returns
The port of this GenericS3Input.
- Return type
int
- property secret_key
Gets the secret_key of this GenericS3Input.
Your generic S3 secret key (required)
- Returns
The secret_key of this GenericS3Input.
- Return type
string_types
- property signature_version
Gets the signature_version of this GenericS3Input.
Specifies the method used for authentication
- Returns
The signature_version of this GenericS3Input.
- Return type
- property signing_region
Gets the signing_region of this GenericS3Input.
The signing region to use
- Returns
The signing_region of this GenericS3Input.
- Return type
string_types
- property ssl
Gets the ssl of this GenericS3Input.
Controls whether SSL is used or not
- Returns
The ssl of this GenericS3Input.
- Return type
bool
bitmovin_api_sdk.models.generic_s3_output module
- class bitmovin_api_sdk.models.generic_s3_output.GenericS3Output(**kwargs)[source]
Bases:
Output- property access_key
Gets the access_key of this GenericS3Output.
Your generic S3 access key (required)
- Returns
The access_key of this GenericS3Output.
- Return type
string_types
- property access_style
Gets the access_style of this GenericS3Output.
Specifies the URL access style to use
- Returns
The access_style of this GenericS3Output.
- Return type
- property attribute_map
- property bucket_name
Gets the bucket_name of this GenericS3Output.
Name of the bucket (required)
- Returns
The bucket_name of this GenericS3Output.
- Return type
string_types
- property host
Gets the host of this GenericS3Output.
The Generic S3 server hostname (or IP address) (required)
- Returns
The host of this GenericS3Output.
- Return type
string_types
- property openapi_types
- property port
Gets the port of this GenericS3Output.
The port on which the Generic S3 server is running on (if not provided 8000 will be used)
- Returns
The port of this GenericS3Output.
- Return type
int
- property secret_key
Gets the secret_key of this GenericS3Output.
Your generic S3 secret key (required)
- Returns
The secret_key of this GenericS3Output.
- Return type
string_types
- property signature_version
Gets the signature_version of this GenericS3Output.
Specifies the method used for authentication
- Returns
The signature_version of this GenericS3Output.
- Return type
- property signing_region
Gets the signing_region of this GenericS3Output.
The signing region to use
- Returns
The signing_region of this GenericS3Output.
- Return type
string_types
- property ssl
Gets the ssl of this GenericS3Output.
Controls whether SSL is used or not
- Returns
The ssl of this GenericS3Output.
- Return type
bool
bitmovin_api_sdk.models.google_cloud_region module
- class bitmovin_api_sdk.models.google_cloud_region.GoogleCloudRegion(value)[source]
Bases:
EnumAn enumeration.
- ASIA_EAST_1 = 'ASIA_EAST_1'
- ASIA_EAST_2 = 'ASIA_EAST_2'
- ASIA_NORTHEAST_1 = 'ASIA_NORTHEAST_1'
- ASIA_SOUTHEAST_1 = 'ASIA_SOUTHEAST_1'
- ASIA_SOUTH_1 = 'ASIA_SOUTH_1'
- AUSTRALIA_SOUTHEAST_1 = 'AUSTRALIA_SOUTHEAST_1'
- EUROPE_NORTH_1 = 'EUROPE_NORTH_1'
- EUROPE_WEST_1 = 'EUROPE_WEST_1'
- EUROPE_WEST_2 = 'EUROPE_WEST_2'
- EUROPE_WEST_3 = 'EUROPE_WEST_3'
- EUROPE_WEST_4 = 'EUROPE_WEST_4'
- ME_CENTRAL_2 = 'ME_CENTRAL_2'
- NORTHAMERICA_NORTHEAST_1 = 'NORTHAMERICA_NORTHEAST_1'
- SOUTHAMERICA_EAST_1 = 'SOUTHAMERICA_EAST_1'
- US_CENTRAL_1 = 'US_CENTRAL_1'
- US_EAST_1 = 'US_EAST_1'
- US_EAST_4 = 'US_EAST_4'
- US_WEST_1 = 'US_WEST_1'
- US_WEST_2 = 'US_WEST_2'
bitmovin_api_sdk.models.group module
bitmovin_api_sdk.models.h262_interlace_mode module
bitmovin_api_sdk.models.h262_preset_configuration module
bitmovin_api_sdk.models.h262_video_configuration module
- class bitmovin_api_sdk.models.h262_video_configuration.H262VideoConfiguration(**kwargs)[source]
Bases:
VideoConfiguration- property attribute_map
- property bframes
Gets the bframes of this H262VideoConfiguration.
Amount of b frames.
- Returns
The bframes of this H262VideoConfiguration.
- Return type
int
- property bufsize
Gets the bufsize of this H262VideoConfiguration.
Playback device buffer size
- Returns
The bufsize of this H262VideoConfiguration.
- Return type
int
- property gop_size
Gets the gop_size of this H262VideoConfiguration.
Minimum GOP length, the minimum distance between I-frames
- Returns
The gop_size of this H262VideoConfiguration.
- Return type
int
- property interlace_mode
Gets the interlace_mode of this H262VideoConfiguration.
Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video
- Returns
The interlace_mode of this H262VideoConfiguration.
- Return type
- property level
Gets the level of this H262VideoConfiguration.
Specified set of constraints that indicate a degree of required decoder performance for a profile
- Returns
The level of this H262VideoConfiguration.
- Return type
- property max_bitrate
Gets the max_bitrate of this H262VideoConfiguration.
Maximum Bitrate
- Returns
The max_bitrate of this H262VideoConfiguration.
- Return type
int
- property min_bitrate
Gets the min_bitrate of this H262VideoConfiguration.
Minimum Bitrate
- Returns
The min_bitrate of this H262VideoConfiguration.
- Return type
int
- property openapi_types
- property preset_configuration
Gets the preset_configuration of this H262VideoConfiguration.
Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.
- Returns
The preset_configuration of this H262VideoConfiguration.
- Return type
- property profile
Gets the profile of this H262VideoConfiguration.
When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen. (required)
- Returns
The profile of this H262VideoConfiguration.
- Return type
bitmovin_api_sdk.models.h264_b_pyramid module
bitmovin_api_sdk.models.h264_dynamic_range_format module
bitmovin_api_sdk.models.h264_interlace_mode module
bitmovin_api_sdk.models.h264_motion_estimation_method module
bitmovin_api_sdk.models.h264_nal_hrd module
bitmovin_api_sdk.models.h264_partition module
bitmovin_api_sdk.models.h264_per_title_configuration module
- class bitmovin_api_sdk.models.h264_per_title_configuration.H264PerTitleConfiguration(**kwargs)[source]
Bases:
PerTitleConfiguration- property attribute_map
- property codec_bufsize_factor
Gets the codec_bufsize_factor of this H264PerTitleConfiguration.
This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate
- Returns
The codec_bufsize_factor of this H264PerTitleConfiguration.
- Return type
float
- property codec_max_bitrate_factor
Gets the codec_max_bitrate_factor of this H264PerTitleConfiguration.
This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate
- Returns
The codec_max_bitrate_factor of this H264PerTitleConfiguration.
- Return type
float
- property codec_min_bitrate_factor
Gets the codec_min_bitrate_factor of this H264PerTitleConfiguration.
This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate
- Returns
The codec_min_bitrate_factor of this H264PerTitleConfiguration.
- Return type
float
- property openapi_types
bitmovin_api_sdk.models.h264_picture_timing_trimming_input_stream module
- class bitmovin_api_sdk.models.h264_picture_timing_trimming_input_stream.H264PictureTimingTrimmingInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property end_pic_timing
Gets the end_pic_timing of this H264PictureTimingTrimmingInputStream.
Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding
- Returns
The end_pic_timing of this H264PictureTimingTrimmingInputStream.
- Return type
string_types
- property input_stream_id
Gets the input_stream_id of this H264PictureTimingTrimmingInputStream.
The id of the ingest input stream that should be trimmed
- Returns
The input_stream_id of this H264PictureTimingTrimmingInputStream.
- Return type
string_types
- property openapi_types
- property start_pic_timing
Gets the start_pic_timing of this H264PictureTimingTrimmingInputStream.
Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding
- Returns
The start_pic_timing of this H264PictureTimingTrimmingInputStream.
- Return type
string_types
bitmovin_api_sdk.models.h264_sub_me module
bitmovin_api_sdk.models.h264_trellis module
bitmovin_api_sdk.models.h264_video_configuration module
- class bitmovin_api_sdk.models.h264_video_configuration.H264VideoConfiguration(**kwargs)[source]
Bases:
VideoConfiguration- property adaptive_quantization_mode
Gets the adaptive_quantization_mode of this H264VideoConfiguration.
Controls the adaptive quantization algorithm
- Returns
The adaptive_quantization_mode of this H264VideoConfiguration.
- Return type
- property adaptive_quantization_strength
Gets the adaptive_quantization_strength of this H264VideoConfiguration.
Values greater than 1 reduce blocking and blurring in flat and textured areas. Values less than 1 reduces ringing artifacts at the cost of more banding artifacts. Negative values are not allowed
- Returns
The adaptive_quantization_strength of this H264VideoConfiguration.
- Return type
float
- property adaptive_spatial_transform
Gets the adaptive_spatial_transform of this H264VideoConfiguration.
Enables adaptive spatial transform (high profile 8x8 transform)
- Returns
The adaptive_spatial_transform of this H264VideoConfiguration.
- Return type
bool
- property attribute_map
- property auto_level_setup
Gets the auto_level_setup of this H264VideoConfiguration.
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.
- Returns
The auto_level_setup of this H264VideoConfiguration.
- Return type
- property b_adaptive_strategy
Gets the b_adaptive_strategy of this H264VideoConfiguration.
- Returns
The b_adaptive_strategy of this H264VideoConfiguration.
- Return type
- property b_pyramid
Gets the b_pyramid of this H264VideoConfiguration.
Keep some B-frames as references
- Returns
The b_pyramid of this H264VideoConfiguration.
- Return type
- property bframes
Gets the bframes of this H264VideoConfiguration.
Amount of b frames
- Returns
The bframes of this H264VideoConfiguration.
- Return type
int
- property bufsize
Gets the bufsize of this H264VideoConfiguration.
Playback device buffer size (bits)
- Returns
The bufsize of this H264VideoConfiguration.
- Return type
int
- property cabac
Gets the cabac of this H264VideoConfiguration.
Enable or disable CABAC
- Returns
The cabac of this H264VideoConfiguration.
- Return type
bool
- property cea608708_subtitle_config
Gets the cea608708_subtitle_config of this H264VideoConfiguration.
Defines whether CEA 608/708 subtitles are copied from the input video stream
- Returns
The cea608708_subtitle_config of this H264VideoConfiguration.
- Return type
- property crf
Gets the crf of this H264VideoConfiguration.
Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.
- Returns
The crf of this H264VideoConfiguration.
- Return type
float
- property deblock_alpha
Gets the deblock_alpha of this H264VideoConfiguration.
Strength of the in-loop deblocking filter. Higher values deblock more effectively but also soften the image
- Returns
The deblock_alpha of this H264VideoConfiguration.
- Return type
int
- property deblock_beta
Gets the deblock_beta of this H264VideoConfiguration.
Threshold of the in-loop deblocking filter. Higher values apply deblocking stronger on non flat blocks, lower values on flat blocks
- Returns
The deblock_beta of this H264VideoConfiguration.
- Return type
int
- property dynamic_range_format
Gets the dynamic_range_format of this H264VideoConfiguration.
Automatically configures the H264 Video Codec to be compatible with the given SDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.
- Returns
The dynamic_range_format of this H264VideoConfiguration.
- Return type
- property fast_skip_detection_p_frames
Gets the fast_skip_detection_p_frames of this H264VideoConfiguration.
Enables fast skip detection on P-frames. Disabling this very slightly increases quality but at a large speed loss
- Returns
The fast_skip_detection_p_frames of this H264VideoConfiguration.
- Return type
bool
- property interlace_mode
Gets the interlace_mode of this H264VideoConfiguration.
Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video
- Returns
The interlace_mode of this H264VideoConfiguration.
- Return type
- property level
Gets the level of this H264VideoConfiguration.
If three-pass encoding is used and a level is set for the encoder, the bitrate for some segments may exceed the bitrate limit which is defined by the level.
- Returns
The level of this H264VideoConfiguration.
- Return type
- property macroblock_tree_ratecontrol
Gets the macroblock_tree_ratecontrol of this H264VideoConfiguration.
Enable macroblock tree ratecontrol. Macroblock tree rate control tracks how often blocks of the frame are used for prediciting future frames
- Returns
The macroblock_tree_ratecontrol of this H264VideoConfiguration.
- Return type
bool
- property max_bitrate
Gets the max_bitrate of this H264VideoConfiguration.
Maximum Bitrate (bps)
- Returns
The max_bitrate of this H264VideoConfiguration.
- Return type
int
- property max_gop
Gets the max_gop of this H264VideoConfiguration.
Maximum GOP length, the maximum distance between I-frames
- Returns
The max_gop of this H264VideoConfiguration.
- Return type
int
- property max_keyframe_interval
Gets the max_keyframe_interval of this H264VideoConfiguration.
Maximum interval in seconds between key frames
- Returns
The max_keyframe_interval of this H264VideoConfiguration.
- Return type
float
- property min_bitrate
Gets the min_bitrate of this H264VideoConfiguration.
Minimum Bitrate (bps)
- Returns
The min_bitrate of this H264VideoConfiguration.
- Return type
int
- property min_gop
Gets the min_gop of this H264VideoConfiguration.
Minimum GOP length, the minimum distance between I-frames
- Returns
The min_gop of this H264VideoConfiguration.
- Return type
int
- property min_keyframe_interval
Gets the min_keyframe_interval of this H264VideoConfiguration.
Minimum interval in seconds between key frames
- Returns
The min_keyframe_interval of this H264VideoConfiguration.
- Return type
float
- property mixed_references
Gets the mixed_references of this H264VideoConfiguration.
Allow references on a per partition basis, rather than per-macroblock basis
- Returns
The mixed_references of this H264VideoConfiguration.
- Return type
bool
- property motion_estimation_method
Gets the motion_estimation_method of this H264VideoConfiguration.
- Returns
The motion_estimation_method of this H264VideoConfiguration.
- Return type
- property mv_prediction_mode
Gets the mv_prediction_mode of this H264VideoConfiguration.
- Returns
The mv_prediction_mode of this H264VideoConfiguration.
- Return type
- property mv_search_range_max
Gets the mv_search_range_max of this H264VideoConfiguration.
Maximum motion vector search range
- Returns
The mv_search_range_max of this H264VideoConfiguration.
- Return type
int
- property nal_hrd
Gets the nal_hrd of this H264VideoConfiguration.
Signal hypothetical reference decoder (HRD) information (requires bufsize to be set)
- Returns
The nal_hrd of this H264VideoConfiguration.
- Return type
- property open_gop
Gets the open_gop of this H264VideoConfiguration.
Enable open-gop, allows referencing frames from a previous gop
- Returns
The open_gop of this H264VideoConfiguration.
- Return type
bool
- property openapi_types
- property partitions
Gets the partitions of this H264VideoConfiguration.
Partitions to consider. Analyzing more partition options improves quality at the cost of speed.
- Returns
The partitions of this H264VideoConfiguration.
- Return type
list[H264Partition]
- property preset_configuration
Gets the preset_configuration of this H264VideoConfiguration.
Choose from a set of preset configurations tailored for common use cases. Check out [H264 Presets](https://bitmovin.com/docs/encoding/tutorials/h264-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset’s value for that property.
- Returns
The preset_configuration of this H264VideoConfiguration.
- Return type
- property profile
Gets the profile of this H264VideoConfiguration.
When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen. (required)
- Returns
The profile of this H264VideoConfiguration.
- Return type
- property psy_rate_distortion_optimization
Gets the psy_rate_distortion_optimization of this H264VideoConfiguration.
Psychovisual Rate Distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP or RD_REF_ALL
- Returns
The psy_rate_distortion_optimization of this H264VideoConfiguration.
- Return type
float
- property psy_trellis
Gets the psy_trellis of this H264VideoConfiguration.
Higher values will improve sharpness and detail retention but might come at costs of artifacts. Needs to have trellis enabled
- Returns
The psy_trellis of this H264VideoConfiguration.
- Return type
float
- property qp_max
Gets the qp_max of this H264VideoConfiguration.
Maximum quantization factor
- Returns
The qp_max of this H264VideoConfiguration.
- Return type
int
- property qp_min
Gets the qp_min of this H264VideoConfiguration.
Minimum quantization factor
- Returns
The qp_min of this H264VideoConfiguration.
- Return type
int
- property quantizer_curve_compression
Gets the quantizer_curve_compression of this H264VideoConfiguration.
Ratio between constant bitrate (0.0) and constant quantizer (1.0). Valid range 0.0 - 1.0
- Returns
The quantizer_curve_compression of this H264VideoConfiguration.
- Return type
float
- property rc_lookahead
Gets the rc_lookahead of this H264VideoConfiguration.
Number of frames for frame-type decision lookahead
- Returns
The rc_lookahead of this H264VideoConfiguration.
- Return type
int
- property ref_frames
Gets the ref_frames of this H264VideoConfiguration.
Amount of reference frames.
- Returns
The ref_frames of this H264VideoConfiguration.
- Return type
int
- property scene_cut_threshold
Gets the scene_cut_threshold of this H264VideoConfiguration.
Scene change sensitivity. The higher the value, the more likely an I-frame will be inserted. Set to 0 to disable it which is advised for scenarios where fixed GOP is required, e.g., adaptive streaming outputs like DASH, HLS and Smooth. Having this setting enabled can improve quality for progressive output with an increased internal chunk length (see internalChunkLength of muxings).
- Returns
The scene_cut_threshold of this H264VideoConfiguration.
- Return type
int
- property slices
Gets the slices of this H264VideoConfiguration.
Number of slices per frame.
- Returns
The slices of this H264VideoConfiguration.
- Return type
int
- property sub_me
Gets the sub_me of this H264VideoConfiguration.
Subpixel motion estimation and mode decision
- Returns
The sub_me of this H264VideoConfiguration.
- Return type
- property trellis
Gets the trellis of this H264VideoConfiguration.
Enables or disables Trellis quantization. NOTE: This requires cabac
- Returns
The trellis of this H264VideoConfiguration.
- Return type
- property weighted_prediction_b_frames
Gets the weighted_prediction_b_frames of this H264VideoConfiguration.
Enable open-gop, allows referencing frames from a previous gop
- Returns
The weighted_prediction_b_frames of this H264VideoConfiguration.
- Return type
bool
- property weighted_prediction_p_frames
Gets the weighted_prediction_p_frames of this H264VideoConfiguration.
Defines the mode for weighted prediction for P-frames
- Returns
The weighted_prediction_p_frames of this H264VideoConfiguration.
- Return type
bitmovin_api_sdk.models.h265_dynamic_range_format module
- class bitmovin_api_sdk.models.h265_dynamic_range_format.H265DynamicRangeFormat(value)[source]
Bases:
EnumAn enumeration.
- DOLBY_VISION = 'DOLBY_VISION'
- DOLBY_VISION_PROFILE_5 = 'DOLBY_VISION_PROFILE_5'
- DOLBY_VISION_PROFILE_8_1 = 'DOLBY_VISION_PROFILE_8_1'
- HDR10 = 'HDR10'
- HLG = 'HLG'
- SDR = 'SDR'
bitmovin_api_sdk.models.h265_per_title_configuration module
- class bitmovin_api_sdk.models.h265_per_title_configuration.H265PerTitleConfiguration(**kwargs)[source]
Bases:
PerTitleConfiguration- property attribute_map
- property codec_bufsize_factor
Gets the codec_bufsize_factor of this H265PerTitleConfiguration.
This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate
- Returns
The codec_bufsize_factor of this H265PerTitleConfiguration.
- Return type
float
- property codec_max_bitrate_factor
Gets the codec_max_bitrate_factor of this H265PerTitleConfiguration.
This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate
- Returns
The codec_max_bitrate_factor of this H265PerTitleConfiguration.
- Return type
float
- property codec_min_bitrate_factor
Gets the codec_min_bitrate_factor of this H265PerTitleConfiguration.
This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate
- Returns
The codec_min_bitrate_factor of this H265PerTitleConfiguration.
- Return type
float
- property openapi_types
bitmovin_api_sdk.models.h265_video_configuration module
- class bitmovin_api_sdk.models.h265_video_configuration.H265VideoConfiguration(**kwargs)[source]
Bases:
VideoConfiguration- property adaptive_quantization_mode
Gets the adaptive_quantization_mode of this H265VideoConfiguration.
Controls the adaptive quantization algorithm
- Returns
The adaptive_quantization_mode of this H265VideoConfiguration.
- Return type
- property adaptive_quantization_motion
Gets the adaptive_quantization_motion of this H265VideoConfiguration.
Adjust the AQ offsets based on the relative motion of each block with respect to the motion of the frame. Default false.
- Returns
The adaptive_quantization_motion of this H265VideoConfiguration.
- Return type
bool
- property adaptive_quantization_strength
Gets the adaptive_quantization_strength of this H265VideoConfiguration.
Adjust the strength of the adaptive quantization offsets. Default 1.0.
- Returns
The adaptive_quantization_strength of this H265VideoConfiguration.
- Return type
float
- property allowed_radl_before_idr
Gets the allowed_radl_before_idr of this H265VideoConfiguration.
Number of RADL pictures allowed infront of IDR. Requires fixed keyframe interval. Valid values 0 - bframes. Default 0.
- Returns
The allowed_radl_before_idr of this H265VideoConfiguration.
- Return type
int
- property analyze_source_frame_pixels
Gets the analyze_source_frame_pixels of this H265VideoConfiguration.
Enable motion estimation with source frame pixels, in this mode, motion estimation can be computed independently. Default false.
- Returns
The analyze_source_frame_pixels of this H265VideoConfiguration.
- Return type
bool
- property asymetric_motion_partitions_analysis
Gets the asymetric_motion_partitions_analysis of this H265VideoConfiguration.
Enable analysis of asymmetric motion partitions.
- Returns
The asymetric_motion_partitions_analysis of this H265VideoConfiguration.
- Return type
bool
- property attribute_map
- property auto_level_setup
Gets the auto_level_setup of this H265VideoConfiguration.
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.
- Returns
The auto_level_setup of this H265VideoConfiguration.
- Return type
- property b_adapt
Gets the b_adapt of this H265VideoConfiguration.
Set the level of effort in determining B frame placement
- Returns
The b_adapt of this H265VideoConfiguration.
- Return type
- property bframe_bias
Gets the bframe_bias of this H265VideoConfiguration.
Bias towards B frames in slicetype decision. The higher the bias the more likely the encoder is to use B frames. Default 0
- Returns
The bframe_bias of this H265VideoConfiguration.
- Return type
int
- property bframes
Gets the bframes of this H265VideoConfiguration.
Amount of b frames
- Returns
The bframes of this H265VideoConfiguration.
- Return type
int
- property blur_complexity
Gets the blur_complexity of this H265VideoConfiguration.
Temporally blur complexity. Default 20.0
- Returns
The blur_complexity of this H265VideoConfiguration.
- Return type
float
- property blur_quants
Gets the blur_quants of this H265VideoConfiguration.
Temporally blur quants. Default 0.5
- Returns
The blur_quants of this H265VideoConfiguration.
- Return type
float
- property bufsize
Gets the bufsize of this H265VideoConfiguration.
Size of the VBV buffer (bits)
- Returns
The bufsize of this H265VideoConfiguration.
- Return type
int
- property cea608708_subtitle_config
Gets the cea608708_subtitle_config of this H265VideoConfiguration.
Defines whether CEA 608/708 subtitles are extracted from the input video stream
- Returns
The cea608708_subtitle_config of this H265VideoConfiguration.
- Return type
- property coding_unit_lossless
Gets the coding_unit_lossless of this H265VideoConfiguration.
If enabled, consider lossless mode in CU RDO decisions. Default is disabled.
- Returns
The coding_unit_lossless of this H265VideoConfiguration.
- Return type
bool
- property constrained_intra_prediction
Gets the constrained_intra_prediction of this H265VideoConfiguration.
When generating intra predictions for blocks in inter slices, only intra-coded reference pixels are used. Default false.
- Returns
The constrained_intra_prediction of this H265VideoConfiguration.
- Return type
bool
- property copy_picture
Gets the copy_picture of this H265VideoConfiguration.
Copy buffers of input picture in frame. Default is enabled.
- Returns
The copy_picture of this H265VideoConfiguration.
- Return type
bool
- property crf
Gets the crf of this H265VideoConfiguration.
Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.
- Returns
The crf of this H265VideoConfiguration.
- Return type
float
- property cutree
Gets the cutree of this H265VideoConfiguration.
Enables the use of lookahead’s lowres motion vector fields to determine the amount of reuse of each block to tune adaptive quantization factors.
- Returns
The cutree of this H265VideoConfiguration.
- Return type
bool
- property dynamic_range_format
Gets the dynamic_range_format of this H265VideoConfiguration.
Automatically configures the H265 Video Codec to be compatible with the given SDR/HDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.
- Returns
The dynamic_range_format of this H265VideoConfiguration.
- Return type
- property dynamic_rate_distortion_strength
Gets the dynamic_rate_distortion_strength of this H265VideoConfiguration.
Increases the RD level at points where quality drops due to VBV rate control enforcement. Default 0.
- Returns
The dynamic_rate_distortion_strength of this H265VideoConfiguration.
- Return type
int
- property early_skip
Gets the early_skip of this H265VideoConfiguration.
Measure 2Nx2N merge candidates first; if no residual is found, additional modes at that depth are not analysed.
- Returns
The early_skip of this H265VideoConfiguration.
- Return type
bool
- property enable_hlg_signaling
Gets the enable_hlg_signaling of this H265VideoConfiguration.
Enable SDR compatible HLG signaling. The container and bitstream will indicate BT.2020 but ARIB STD-B67 will be signaled in the alternative transfer characteristics SEI message.
- Returns
The enable_hlg_signaling of this H265VideoConfiguration.
- Return type
bool
- property enable_hrd_signaling
Gets the enable_hrd_signaling of this H265VideoConfiguration.
Signal hypothetical reference decoder (HRD) information
- Returns
The enable_hrd_signaling of this H265VideoConfiguration.
- Return type
bool
- property evaluation_of_intra_modes_in_b_slices
Gets the evaluation_of_intra_modes_in_b_slices of this H265VideoConfiguration.
Enables the evaluation of intra modes in B slices.
- Returns
The evaluation_of_intra_modes_in_b_slices of this H265VideoConfiguration.
- Return type
bool
- property fast_search_for_angular_intra_predictions
Gets the fast_search_for_angular_intra_predictions of this H265VideoConfiguration.
Enable faster search method for angular intra predictions.
- Returns
The fast_search_for_angular_intra_predictions of this H265VideoConfiguration.
- Return type
bool
- property force_flush
Gets the force_flush of this H265VideoConfiguration.
Force the encoder to flush frames. Default is DISABLED.
- Returns
The force_flush of this H265VideoConfiguration.
- Return type
- property gop_lookahead
Gets the gop_lookahead of this H265VideoConfiguration.
Number of frames for GOP boundary decision lookahead. Valid values 0 - rcLookahead. Default 0
- Returns
The gop_lookahead of this H265VideoConfiguration.
- Return type
int
- property grain_optimized_rate_control
Gets the grain_optimized_rate_control of this H265VideoConfiguration.
Enables a specialised ratecontrol algorithm for film grain content. Default false.
- Returns
The grain_optimized_rate_control of this H265VideoConfiguration.
- Return type
bool
- property hdr
Gets the hdr of this H265VideoConfiguration.
Force signaling of HDR parameters in SEI packets. Enabled automatically when masterDisplay or maxContentLightLevel/maxPictureAverageLightLevel are set. Useful when there is a desire to signal 0 values for maxContentLightLevel and maxPictureAverageLightLevel.
- Returns
The hdr of this H265VideoConfiguration.
- Return type
bool
- property ip_ratio
Gets the ip_ratio of this H265VideoConfiguration.
QP ratio factor between I and P slices. This ratio is used in all of the rate control modes. Default 1.4
- Returns
The ip_ratio of this H265VideoConfiguration.
- Return type
float
- property level
Gets the level of this H265VideoConfiguration.
- Returns
The level of this H265VideoConfiguration.
- Return type
- property level_high_tier
Gets the level_high_tier of this H265VideoConfiguration.
If high tier is disabled the encoder will attempt to encode only at the main tier. Default is enabled.
- Returns
The level_high_tier of this H265VideoConfiguration.
- Return type
bool
- property limit_modes
Gets the limit_modes of this H265VideoConfiguration.
When enabled, will limit modes analyzed for each CU using cost metrics from the 4 sub-CUs. This can significantly improve performance when rectangularMotionPartitionsAnalysis and/or asymetricMotionPartitionsAnalysis are enabled at minimal compression efficiency loss.
- Returns
The limit_modes of this H265VideoConfiguration.
- Return type
bool
- property limit_references
Gets the limit_references of this H265VideoConfiguration.
If enabled, limit references per depth, CU or both.
- Returns
The limit_references of this H265VideoConfiguration.
- Return type
- property limit_sao
Gets the limit_sao of this H265VideoConfiguration.
Limit SAO filter computation by early terminating SAO process based on inter prediction mode, CTU spatial-domain correlations, and relations between luma and chroma. Default false.
- Returns
The limit_sao of this H265VideoConfiguration.
- Return type
bool
- property limit_transform_unit_depth_recursion
Gets the limit_transform_unit_depth_recursion of this H265VideoConfiguration.
Enables early exit from transform unit depth recursion, for inter coded blocks. Default is DISABLED.
- Returns
The limit_transform_unit_depth_recursion of this H265VideoConfiguration.
- Return type
- property lookahead_slices
Gets the lookahead_slices of this H265VideoConfiguration.
Use multiple worker threads to measure the estimated cost of each frame within the lookahead. The higher this parameter, the less accurate the frame costs will be which will result in less accurate B-frame and scene-cut decisions. Valid range: 0 - 16
- Returns
The lookahead_slices of this H265VideoConfiguration.
- Return type
int
- property lowpass_dct
Gets the lowpass_dct of this H265VideoConfiguration.
Will use low-pass subband dct approximation instead of the standard dct for 16x16 and 32x32 blocks. Default false.
- Returns
The lowpass_dct of this H265VideoConfiguration.
- Return type
bool
- property master_display
Gets the master_display of this H265VideoConfiguration.
Set the mastering display color volume SEI info (SMPTE ST 2086). For example G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1) describes a P3D65 1000-nits monitor, where G(x=0.265, y=0.690), B(x=0.150, y=0.060), R(x=0.680, y=0.320), WP(x=0.3127, y=0.3290), L(max=1000, min=0.0001). Part of HDR-10 metadata. If used on a Dolby Vision stream, this value must be set to G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1).
- Returns
The master_display of this H265VideoConfiguration.
- Return type
string_types
- property max_bitrate
Gets the max_bitrate of this H265VideoConfiguration.
Maximum Bitrate (bps)
- Returns
The max_bitrate of this H265VideoConfiguration.
- Return type
int
- property max_content_light_level
Gets the max_content_light_level of this H265VideoConfiguration.
Set the max content light level (MaxCLL). Use together with maxPictureAverageLightLevel (which will be 0 if not set). Part of HDR-10 metadata.
- Returns
The max_content_light_level of this H265VideoConfiguration.
- Return type
int
- property max_ctu_size
Gets the max_ctu_size of this H265VideoConfiguration.
- Returns
The max_ctu_size of this H265VideoConfiguration.
- Return type
- property max_gop
Gets the max_gop of this H265VideoConfiguration.
Maximum GOP length, the maximum distance between I-frames
- Returns
The max_gop of this H265VideoConfiguration.
- Return type
int
- property max_keyframe_interval
Gets the max_keyframe_interval of this H265VideoConfiguration.
Maximum interval in seconds between key frames
- Returns
The max_keyframe_interval of this H265VideoConfiguration.
- Return type
float
- property max_merge
Gets the max_merge of this H265VideoConfiguration.
Maximum number of neighbor (spatial and temporal) candidate blocks that the encoder may consider for merging motion predictions. Valid range: 1 - 5
- Returns
The max_merge of this H265VideoConfiguration.
- Return type
int
- property max_picture_average_light_level
Gets the max_picture_average_light_level of this H265VideoConfiguration.
Set the maximum picture average light level (MaxFALL). Use together with maxContentLightLevel (which will be 0 if not set). Part of HDR-10 metadata.
- Returns
The max_picture_average_light_level of this H265VideoConfiguration.
- Return type
int
- property maximum_transform_unit_size
Gets the maximum_transform_unit_size of this H265VideoConfiguration.
Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.
- Returns
The maximum_transform_unit_size of this H265VideoConfiguration.
- Return type
- property min_bitrate
Gets the min_bitrate of this H265VideoConfiguration.
Minimum Bitrate (bps)
- Returns
The min_bitrate of this H265VideoConfiguration.
- Return type
int
- property min_coding_unit_size
Gets the min_coding_unit_size of this H265VideoConfiguration.
Minimum CU size (width and height). By using 16 or 32 the encoder will not analyze the cost of CUs below that minimum threshold, saving considerable amounts of compute with a predictable increase in bitrate. This setting has a large effect on performance on the faster presets.
- Returns
The min_coding_unit_size of this H265VideoConfiguration.
- Return type
- property min_gop
Gets the min_gop of this H265VideoConfiguration.
Minimum GOP length, the minimum distance between I-frames
- Returns
The min_gop of this H265VideoConfiguration.
- Return type
int
- property min_keyframe_interval
Gets the min_keyframe_interval of this H265VideoConfiguration.
Minimum interval in seconds between key frames
- Returns
The min_keyframe_interval of this H265VideoConfiguration.
- Return type
float
- property motion_search
Gets the motion_search of this H265VideoConfiguration.
- Returns
The motion_search of this H265VideoConfiguration.
- Return type
- property motion_search_range
Gets the motion_search_range of this H265VideoConfiguration.
Set the Motion search range.
- Returns
The motion_search_range of this H265VideoConfiguration.
- Return type
int
- property noise_reduction_inter
Gets the noise_reduction_inter of this H265VideoConfiguration.
An integer value, which denotes strength of noise reduction in inter CUs. Default 0.
- Returns
The noise_reduction_inter of this H265VideoConfiguration.
- Return type
int
- property noise_reduction_intra
Gets the noise_reduction_intra of this H265VideoConfiguration.
An integer value, which denotes strength of noise reduction in intra CUs. Default 0.
- Returns
The noise_reduction_intra of this H265VideoConfiguration.
- Return type
int
- property open_gop
Gets the open_gop of this H265VideoConfiguration.
Enable open-gop, allows referencing frames from a previous gop
- Returns
The open_gop of this H265VideoConfiguration.
- Return type
bool
- property openapi_types
- property pb_ratio
Gets the pb_ratio of this H265VideoConfiguration.
QP ratio factor between P and B slices. This ratio is used in all of the rate control modes. Default 1.3
- Returns
The pb_ratio of this H265VideoConfiguration.
- Return type
float
- property preset_configuration
Gets the preset_configuration of this H265VideoConfiguration.
Choose from a set of preset configurations tailored for common use cases. Check out [H265 Presets](https://bitmovin.com/docs/encoding/tutorials/h265-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset’s value for that property.
- Returns
The preset_configuration of this H265VideoConfiguration.
- Return type
- property profile
Gets the profile of this H265VideoConfiguration.
- Returns
The profile of this H265VideoConfiguration.
- Return type
- property psy_rate_distortion_optimization
Gets the psy_rate_distortion_optimization of this H265VideoConfiguration.
Psycho-visual rate-distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP, RD_REF_ALL, QPRD or FULL_RD
- Returns
The psy_rate_distortion_optimization of this H265VideoConfiguration.
- Return type
float
- property psy_rate_distortion_optimized_quantization
Gets the psy_rate_distortion_optimized_quantization of this H265VideoConfiguration.
Strength of psycho-visual optimizations in quantization. Only has an effect in presets which use RDOQ (rd-levels 4 and 5). The value must be between 0 and 50, 1.0 is typical
- Returns
The psy_rate_distortion_optimized_quantization of this H265VideoConfiguration.
- Return type
float
- property qp
Gets the qp of this H265VideoConfiguration.
Quantization factor
- Returns
The qp of this H265VideoConfiguration.
- Return type
int
- property qp_max
Gets the qp_max of this H265VideoConfiguration.
Maximum quantization factor. Valid value range: 0 - 69
- Returns
The qp_max of this H265VideoConfiguration.
- Return type
int
- property qp_min
Gets the qp_min of this H265VideoConfiguration.
Minimum quantization factor. Valid value range: 0 - 69
- Returns
The qp_min of this H265VideoConfiguration.
- Return type
int
- property qp_offset_chroma_cb
Gets the qp_offset_chroma_cb of this H265VideoConfiguration.
Offset of Cb chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0
- Returns
The qp_offset_chroma_cb of this H265VideoConfiguration.
- Return type
int
- property qp_offset_chroma_cr
Gets the qp_offset_chroma_cr of this H265VideoConfiguration.
Offset of Cr chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0
- Returns
The qp_offset_chroma_cr of this H265VideoConfiguration.
- Return type
int
- property qp_step
Gets the qp_step of this H265VideoConfiguration.
The maximum single adjustment in QP allowed to rate control. Default 4
- Returns
The qp_step of this H265VideoConfiguration.
- Return type
int
- property quantization_group_size
Gets the quantization_group_size of this H265VideoConfiguration.
Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted. Default is same as maxCTUSize.
- Returns
The quantization_group_size of this H265VideoConfiguration.
- Return type
- property quantizer_curve_compression_factor
Gets the quantizer_curve_compression_factor of this H265VideoConfiguration.
Quantizer curve compression factor. It weights the frame quantizer based on the complexity of residual (measured by lookahead). Default 0.6
- Returns
The quantizer_curve_compression_factor of this H265VideoConfiguration.
- Return type
float
- property rate_distortion_level_for_mode_decision
Gets the rate_distortion_level_for_mode_decision of this H265VideoConfiguration.
Level of rate-distortion optimization in mode decision. The lower the value the faster the encode, the higher the value higher the compression efficiency. Valid range: 0 - 4
- Returns
The rate_distortion_level_for_mode_decision of this H265VideoConfiguration.
- Return type
int
- property rate_distortion_level_for_quantization
Gets the rate_distortion_level_for_quantization of this H265VideoConfiguration.
Specifies the amount of rate-distortion analysis to use within quantization.
- Returns
The rate_distortion_level_for_quantization of this H265VideoConfiguration.
- Return type
- property rate_distortion_penalty
Gets the rate_distortion_penalty of this H265VideoConfiguration.
Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.
- Returns
The rate_distortion_penalty of this H265VideoConfiguration.
- Return type
- property rc_lookahead
Gets the rc_lookahead of this H265VideoConfiguration.
Number of frames for slice-type decision lookahead
- Returns
The rc_lookahead of this H265VideoConfiguration.
- Return type
int
- property rectangular_motion_partitions_analysis
Gets the rectangular_motion_partitions_analysis of this H265VideoConfiguration.
Enable analysis of rectangular motion partitions Nx2N and 2NxN.
- Returns
The rectangular_motion_partitions_analysis of this H265VideoConfiguration.
- Return type
bool
- property recursion_skip
Gets the recursion_skip of this H265VideoConfiguration.
If enabled exits early from CU depth recursion. When a skip CU is found, additional heuristics are used to decide whether to terminate recursion.
- Returns
The recursion_skip of this H265VideoConfiguration.
- Return type
bool
- property ref_frames
Gets the ref_frames of this H265VideoConfiguration.
Amount of reference frames
- Returns
The ref_frames of this H265VideoConfiguration.
- Return type
int
- property refine_rate_distortion_cost
Gets the refine_rate_distortion_cost of this H265VideoConfiguration.
Enable QP based rate distortion refinement. Default is disabled.
- Returns
The refine_rate_distortion_cost of this H265VideoConfiguration.
- Return type
bool
- property sao
Gets the sao of this H265VideoConfiguration.
Toggle sample adaptive offset loop filter
- Returns
The sao of this H265VideoConfiguration.
- Return type
bool
- property sao_non_deblock
Gets the sao_non_deblock of this H265VideoConfiguration.
Specify how to handle depencency between SAO and deblocking filter. When enabled, non-deblocked pixels are used for SAO analysis. When disabled, SAO analysis skips the right/bottom boundary areas. Default false.
- Returns
The sao_non_deblock of this H265VideoConfiguration.
- Return type
bool
- property scene_cut_threshold
Gets the scene_cut_threshold of this H265VideoConfiguration.
Scene Change sensitivity. The higher the value, the more likely an I-Frame will be inserted. Set to 0 to disable it.
- Returns
The scene_cut_threshold of this H265VideoConfiguration.
- Return type
int
- property scenecut_bias
Gets the scenecut_bias of this H265VideoConfiguration.
This value represents the percentage difference between the inter cost and intra cost of a frame used in scenecut detection. Default 5.0.
- Returns
The scenecut_bias of this H265VideoConfiguration.
- Return type
float
- property sign_hide
Gets the sign_hide of this H265VideoConfiguration.
Hide sign bit of one coefficient per coding tree unit.
- Returns
The sign_hide of this H265VideoConfiguration.
- Return type
bool
- property skip_split_rate_distortion_analysis
Gets the skip_split_rate_distortion_analysis of this H265VideoConfiguration.
Enable skipping split rate distortion analysis when sum of split CU RD cost larger than one split CU RD cost for intra CU. Default disabled.
- Returns
The skip_split_rate_distortion_analysis of this H265VideoConfiguration.
- Return type
bool
- property slices
Gets the slices of this H265VideoConfiguration.
Encode each incoming frame as multiple parallel slices that may be decoded independently. Default is 1.
- Returns
The slices of this H265VideoConfiguration.
- Return type
int
- property ssim_rate_distortion_optimization
Gets the ssim_rate_distortion_optimization of this H265VideoConfiguration.
It is used for mode selection during analysis of CTUs and can achieve significant gain in terms of objective quality metrics SSIM and PSNR. Default false.
- Returns
The ssim_rate_distortion_optimization of this H265VideoConfiguration.
- Return type
bool
- property strict_cbr
Gets the strict_cbr of this H265VideoConfiguration.
Enables stricter conditions to control bitrate deviance from the target bitrate in ABR mode. Bit rate adherence is prioritised over quality. Default false.
- Returns
The strict_cbr of this H265VideoConfiguration.
- Return type
bool
- property strong_intra_smoothing
Gets the strong_intra_smoothing of this H265VideoConfiguration.
Enable strong intra smoothing for 32x32 intra blocks. Default true.
- Returns
The strong_intra_smoothing of this H265VideoConfiguration.
- Return type
bool
- property sub_me
Gets the sub_me of this H265VideoConfiguration.
Set the amount of subpel refinement to perform.
- Returns
The sub_me of this H265VideoConfiguration.
- Return type
int
- property temporal_motion_vector_predictors
Gets the temporal_motion_vector_predictors of this H265VideoConfiguration.
Enable temporal motion vector predictors in P and B slices. Default true.
- Returns
The temporal_motion_vector_predictors of this H265VideoConfiguration.
- Return type
bool
- property transform_skip
Gets the transform_skip of this H265VideoConfiguration.
Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks. Default is NONE.
- Returns
The transform_skip of this H265VideoConfiguration.
- Return type
- property tu_inter_depth
Gets the tu_inter_depth of this H265VideoConfiguration.
- Returns
The tu_inter_depth of this H265VideoConfiguration.
- Return type
- property tu_intra_depth
Gets the tu_intra_depth of this H265VideoConfiguration.
- Returns
The tu_intra_depth of this H265VideoConfiguration.
- Return type
- property video_format
Gets the video_format of this H265VideoConfiguration.
Specifies the source format of the original analog video prior to digitizing and encoding
- Returns
The video_format of this H265VideoConfiguration.
- Return type
- property wavefront_parallel_processing
Gets the wavefront_parallel_processing of this H265VideoConfiguration.
The encoder may begin encoding a row as soon as the row above it is at least two CTUs ahead in the encode process. Default is enabled.
- Returns
The wavefront_parallel_processing of this H265VideoConfiguration.
- Return type
bool
- property weight_prediction_on_b_slice
Gets the weight_prediction_on_b_slice of this H265VideoConfiguration.
Enable weighted prediction in B slices
- Returns
The weight_prediction_on_b_slice of this H265VideoConfiguration.
- Return type
bool
- property weight_prediction_on_p_slice
Gets the weight_prediction_on_p_slice of this H265VideoConfiguration.
Enable weighted prediction in P slices
- Returns
The weight_prediction_on_p_slice of this H265VideoConfiguration.
- Return type
bool
bitmovin_api_sdk.models.he_aac_v1_audio_configuration module
- class bitmovin_api_sdk.models.he_aac_v1_audio_configuration.HeAacV1AudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this HeAacV1AudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this HeAacV1AudioConfiguration.
- Return type
- property openapi_types
- property signaling
Gets the signaling of this HeAacV1AudioConfiguration.
Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.
- Returns
The signaling of this HeAacV1AudioConfiguration.
- Return type
bitmovin_api_sdk.models.he_aac_v1_signaling module
bitmovin_api_sdk.models.he_aac_v2_audio_configuration module
- class bitmovin_api_sdk.models.he_aac_v2_audio_configuration.HeAacV2AudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this HeAacV2AudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this HeAacV2AudioConfiguration.
- Return type
- property openapi_types
- property signaling
Gets the signaling of this HeAacV2AudioConfiguration.
Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.
- Returns
The signaling of this HeAacV2AudioConfiguration.
- Return type
bitmovin_api_sdk.models.he_aac_v2_signaling module
bitmovin_api_sdk.models.hls_manifest module
- class bitmovin_api_sdk.models.hls_manifest.HlsManifest(**kwargs)[source]
Bases:
Manifest- property attribute_map
- property channels_attribute_for_audio
Gets the channels_attribute_for_audio of this HlsManifest.
Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag
- Returns
The channels_attribute_for_audio of this HlsManifest.
- Return type
- property hls_master_playlist_version
Gets the hls_master_playlist_version of this HlsManifest.
If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version
- Returns
The hls_master_playlist_version of this HlsManifest.
- Return type
- property hls_media_playlist_version
Gets the hls_media_playlist_version of this HlsManifest.
If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version
- Returns
The hls_media_playlist_version of this HlsManifest.
- Return type
- property manifest_name
Gets the manifest_name of this HlsManifest.
The filename of your manifest. If this is not set, the name is used as output file name. Either one of name or manifestName is required. Be aware that spaces will be replaced with underlines (_) on the output.
- Returns
The manifest_name of this HlsManifest.
- Return type
string_types
- property openapi_types
- property target_duration_rounding_mode
Gets the target_duration_rounding_mode of this HlsManifest.
The rounding applied to target duration. Two possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer, or UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.
- Returns
The target_duration_rounding_mode of this HlsManifest.
- Return type
bitmovin_api_sdk.models.hls_manifest_ad_marker_settings module
- class bitmovin_api_sdk.models.hls_manifest_ad_marker_settings.HlsManifestAdMarkerSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property enabled_marker_types
Gets the enabled_marker_types of this HlsManifestAdMarkerSettings.
Ad marker types that will be inserted. More than one type is possible. - EXT_X_CUE_OUT_IN: Ad markers will be inserted using #EXT-X-CUE-OUT and #EXT-X-CUE-IN tags - EXT_OATCLS_SCTE35: Ad markers will be inserted using #EXT-OATCLS-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger. - EXT_X_SPLICEPOINT_SCTE35: Ad markers will be inserted using #EXT-X-SPLICEPOINT-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger. - EXT_X_DATERANGE: Ad markers will be inserted using #EXT-X-DATERANGE tags. They contain the ID, start timestamp and hex encoded raw bytes of the original SCTE-35 trigger. - EXT_X_SCTE35: Ad markers will be inserted using #EXT-X-SCTE35 tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.
- Returns
The enabled_marker_types of this HlsManifestAdMarkerSettings.
- Return type
list[HlsManifestAdMarkerType]
- property openapi_types
bitmovin_api_sdk.models.hls_manifest_ad_marker_type module
- class bitmovin_api_sdk.models.hls_manifest_ad_marker_type.HlsManifestAdMarkerType(value)[source]
Bases:
EnumAn enumeration.
- EXT_OATCLS_SCTE35 = 'EXT_OATCLS_SCTE35'
- EXT_X_CUE_OUT_IN = 'EXT_X_CUE_OUT_IN'
- EXT_X_DATERANGE = 'EXT_X_DATERANGE'
- EXT_X_SCTE35 = 'EXT_X_SCTE35'
- EXT_X_SPLICEPOINT_SCTE35 = 'EXT_X_SPLICEPOINT_SCTE35'
bitmovin_api_sdk.models.hls_manifest_default module
- class bitmovin_api_sdk.models.hls_manifest_default.HlsManifestDefault(**kwargs)[source]
Bases:
HlsManifest- property attribute_map
- property encoding_id
Gets the encoding_id of this HlsManifestDefault.
The id of the encoding to create a default manifest for (required)
- Returns
The encoding_id of this HlsManifestDefault.
- Return type
string_types
- property openapi_types
- property version
Gets the version of this HlsManifestDefault.
Currently not in use
- Returns
The version of this HlsManifestDefault.
- Return type
bitmovin_api_sdk.models.hls_manifest_default_version module
bitmovin_api_sdk.models.hls_target_duration_rounding_mode module
bitmovin_api_sdk.models.hls_version module
bitmovin_api_sdk.models.http_input module
- class bitmovin_api_sdk.models.http_input.HttpInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property host
Gets the host of this HttpInput.
Host Url or IP of the HTTP server (required)
- Returns
The host of this HttpInput.
- Return type
string_types
- property openapi_types
- property password
Gets the password of this HttpInput.
Basic Auth Password, if required
- Returns
The password of this HttpInput.
- Return type
string_types
- property port
Gets the port of this HttpInput.
Custom Port
- Returns
The port of this HttpInput.
- Return type
int
- property username
Gets the username of this HttpInput.
Basic Auth Username, if required
- Returns
The username of this HttpInput.
- Return type
string_types
bitmovin_api_sdk.models.https_input module
- class bitmovin_api_sdk.models.https_input.HttpsInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property host
Gets the host of this HttpsInput.
Host Url or IP of the HTTP server (required)
- Returns
The host of this HttpsInput.
- Return type
string_types
- property openapi_types
- property password
Gets the password of this HttpsInput.
Basic Auth Password, if required
- Returns
The password of this HttpsInput.
- Return type
string_types
- property port
Gets the port of this HttpsInput.
Custom Port
- Returns
The port of this HttpsInput.
- Return type
int
- property username
Gets the username of this HttpsInput.
Basic Auth Username, if required
- Returns
The username of this HttpsInput.
- Return type
string_types
bitmovin_api_sdk.models.i_frame_playlist module
- class bitmovin_api_sdk.models.i_frame_playlist.IFramePlaylist(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property filename
Gets the filename of this IFramePlaylist.
The filename of your I-frame playlist (required)
- Returns
The filename of this IFramePlaylist.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.id3_tag module
- class bitmovin_api_sdk.models.id3_tag.Id3Tag(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- discriminator_value_class_map = {'FRAME_ID': 'FrameIdId3Tag', 'PLAIN_TEXT': 'PlaintextId3Tag', 'RAW': 'RawId3Tag'}
- property frame
Gets the frame of this Id3Tag.
Frame number at which the Tag should be inserted
- Returns
The frame of this Id3Tag.
- Return type
int
- property openapi_types
- property position_mode
Gets the position_mode of this Id3Tag.
- Returns
The position_mode of this Id3Tag.
- Return type
- property time
Gets the time of this Id3Tag.
Time in seconds where the Tag should be inserted
- Returns
The time of this Id3Tag.
- Return type
float
bitmovin_api_sdk.models.id3_tag_position_mode module
bitmovin_api_sdk.models.id3_tag_type module
bitmovin_api_sdk.models.ignored_by module
bitmovin_api_sdk.models.ignoring module
- class bitmovin_api_sdk.models.ignoring.Ignoring(**kwargs)[source]
Bases:
object- property attribute_map
- property ignored_by
Gets the ignored_by of this Ignoring.
- Returns
The ignored_by of this Ignoring.
- Return type
- property ignored_by_description
Gets the ignored_by_description of this Ignoring.
Describes why ignoredBy has been set to its current value.
- Returns
The ignored_by_description of this Ignoring.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.image_adaptation_set module
bitmovin_api_sdk.models.imsc_configuration module
bitmovin_api_sdk.models.imsc_styling module
bitmovin_api_sdk.models.imsc_styling_mode module
bitmovin_api_sdk.models.infrastructure_settings module
- class bitmovin_api_sdk.models.infrastructure_settings.InfrastructureSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property cloud_region
Gets the cloud_region of this InfrastructureSettings.
- Returns
The cloud_region of this InfrastructureSettings.
- Return type
- property infrastructure_id
Gets the infrastructure_id of this InfrastructureSettings.
Id of a custom infrastructure, e.g., AWS Cloud Connect
- Returns
The infrastructure_id of this InfrastructureSettings.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.ingest_input_stream module
- class bitmovin_api_sdk.models.ingest_input_stream.IngestInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property input_id
Gets the input_id of this IngestInputStream.
ID of an Input resource defining the input storage (required)
- Returns
The input_id of this IngestInputStream.
- Return type
string_types
- property input_path
Gets the input_path of this IngestInputStream.
Path to an input media file (required)
- Returns
The input_path of this IngestInputStream.
- Return type
string_types
- property openapi_types
- property position
Gets the position of this IngestInputStream.
Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode ‘AUTO’, defaults to 0 for any other selectionMode.
- Returns
The position of this IngestInputStream.
- Return type
int
- property selection_mode
Gets the selection_mode of this IngestInputStream.
Specifies the strategy for selecting a stream from the input file
- Returns
The selection_mode of this IngestInputStream.
- Return type
bitmovin_api_sdk.models.input module
- class bitmovin_api_sdk.models.input.Input(**kwargs)[source]
Bases:
BitmovinResource- discriminator_value_class_map = {'AKAMAI_NETSTORAGE': 'AkamaiNetStorageInput', 'ASPERA': 'AsperaInput', 'AZURE': 'AzureInput', 'DIRECT_FILE_UPLOAD': 'DirectFileUploadInput', 'FTP': 'FtpInput', 'GCS': 'GcsInput', 'GCS_SERVICE_ACCOUNT': 'GcsServiceAccountInput', 'GENERIC_S3': 'GenericS3Input', 'HTTP': 'HttpInput', 'HTTPS': 'HttpsInput', 'LOCAL': 'LocalInput', 'REDUNDANT_RTMP': 'RedundantRtmpInput', 'RTMP': 'RtmpInput', 'S3': 'S3Input', 'S3_ROLE_BASED': 'S3RoleBasedInput', 'SFTP': 'SftpInput', 'SRT': 'SrtInput', 'ZIXI': 'ZixiInput'}
bitmovin_api_sdk.models.input_color_primaries module
- class bitmovin_api_sdk.models.input_color_primaries.InputColorPrimaries(value)[source]
Bases:
EnumAn enumeration.
- BT2020 = 'BT2020'
- BT470BG = 'BT470BG'
- BT470M = 'BT470M'
- BT709 = 'BT709'
- FILM = 'FILM'
- JEDEC_P22 = 'JEDEC_P22'
- SMPTE170M = 'SMPTE170M'
- SMPTE240M = 'SMPTE240M'
- SMPTE428 = 'SMPTE428'
- SMPTE431 = 'SMPTE431'
- SMPTE432 = 'SMPTE432'
- SMPTEST428_1 = 'SMPTEST428_1'
- UNSPECIFIED = 'UNSPECIFIED'
bitmovin_api_sdk.models.input_color_range module
bitmovin_api_sdk.models.input_color_space module
- class bitmovin_api_sdk.models.input_color_space.InputColorSpace(value)[source]
Bases:
EnumAn enumeration.
- BT2020_CL = 'BT2020_CL'
- BT2020_NCL = 'BT2020_NCL'
- BT470BG = 'BT470BG'
- BT709 = 'BT709'
- FCC = 'FCC'
- RGB = 'RGB'
- SMPTE170M = 'SMPTE170M'
- SMPTE2085 = 'SMPTE2085'
- SMPTE240M = 'SMPTE240M'
- UNSPECIFIED = 'UNSPECIFIED'
- YCGCO = 'YCGCO'
- YCOCG = 'YCOCG'
bitmovin_api_sdk.models.input_color_transfer module
- class bitmovin_api_sdk.models.input_color_transfer.InputColorTransfer(value)[source]
Bases:
EnumAn enumeration.
- ARIB_STD_B67 = 'ARIB_STD_B67'
- BT1361_ECG = 'BT1361_ECG'
- BT2020_10 = 'BT2020_10'
- BT2020_12 = 'BT2020_12'
- BT709 = 'BT709'
- GAMMA22 = 'GAMMA22'
- GAMMA28 = 'GAMMA28'
- IEC61966_2_1 = 'IEC61966_2_1'
- IEC61966_2_4 = 'IEC61966_2_4'
- LINEAR = 'LINEAR'
- LOG = 'LOG'
- LOG_SQRT = 'LOG_SQRT'
- SMPTE170M = 'SMPTE170M'
- SMPTE2084 = 'SMPTE2084'
- SMPTE240M = 'SMPTE240M'
- SMPTE428 = 'SMPTE428'
- UNSPECIFIED = 'UNSPECIFIED'
bitmovin_api_sdk.models.input_factor module
- class bitmovin_api_sdk.models.input_factor.InputFactor(**kwargs)[source]
Bases:
object- property attribute_map
- property bitrate
Gets the bitrate of this InputFactor.
- Returns
The bitrate of this InputFactor.
- Return type
- property codec
Gets the codec of this InputFactor.
- Returns
The codec of this InputFactor.
- Return type
- property openapi_types
bitmovin_api_sdk.models.input_factor_bitrate module
- class bitmovin_api_sdk.models.input_factor_bitrate.InputFactorBitrate(**kwargs)[source]
Bases:
object- property attribute_map
- property factor
Gets the factor of this InputFactorBitrate.
- Returns
The factor of this InputFactorBitrate.
- Return type
float
- property openapi_types
- property value
Gets the value of this InputFactorBitrate.
- Returns
The value of this InputFactorBitrate.
- Return type
int
bitmovin_api_sdk.models.input_factor_codec module
- class bitmovin_api_sdk.models.input_factor_codec.InputFactorCodec(**kwargs)[source]
Bases:
object- property attribute_map
- property factor
Gets the factor of this InputFactorCodec.
- Returns
The factor of this InputFactorCodec.
- Return type
float
- property openapi_types
- property value
Gets the value of this InputFactorCodec.
- Returns
The value of this InputFactorCodec.
- Return type
string_types
bitmovin_api_sdk.models.input_path module
- class bitmovin_api_sdk.models.input_path.InputPath(**kwargs)[source]
Bases:
object- property attribute_map
- property input_id
Gets the input_id of this InputPath.
Id of input (required)
- Returns
The input_id of this InputPath.
- Return type
string_types
- property input_path
Gets the input_path of this InputPath.
Path to media file (required)
- Returns
The input_path of this InputPath.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.input_stream module
- class bitmovin_api_sdk.models.input_stream.InputStream(**kwargs)[source]
Bases:
BitmovinResource- discriminator_value_class_map = {'AUDIO_MIX': 'AudioMixInputStream', 'CAPTION_CEA608': 'Cea608CaptionInputStream', 'CAPTION_CEA708': 'Cea708CaptionInputStream', 'CONCATENATION': 'ConcatenationInputStream', 'DOLBY_ATMOS': 'DolbyAtmosIngestInputStream', 'DOLBY_VISION': 'DolbyVisionInputStream', 'DVB_SUBTITLE': 'DvbSubtitleInputStream', 'FILE': 'FileInputStream', 'INGEST': 'IngestInputStream', 'SIDECAR_DOLBY_VISION_METADATA': 'DolbyVisionMetadataIngestInputStream', 'TRIMMING_H264_PICTURE_TIMING': 'H264PictureTimingTrimmingInputStream', 'TRIMMING_TIME_BASED': 'TimeBasedTrimmingInputStream', 'TRIMMING_TIME_CODE_TRACK': 'TimecodeTrackTrimmingInputStream'}
bitmovin_api_sdk.models.input_stream_type module
- class bitmovin_api_sdk.models.input_stream_type.InputStreamType(value)[source]
Bases:
EnumAn enumeration.
- AUDIO_MIX = 'AUDIO_MIX'
- CAPTION_CEA608 = 'CAPTION_CEA608'
- CAPTION_CEA708 = 'CAPTION_CEA708'
- CONCATENATION = 'CONCATENATION'
- DOLBY_ATMOS = 'DOLBY_ATMOS'
- DOLBY_VISION = 'DOLBY_VISION'
- DVB_SUBTITLE = 'DVB_SUBTITLE'
- FILE = 'FILE'
- INGEST = 'INGEST'
- SIDECAR_DOLBY_VISION_METADATA = 'SIDECAR_DOLBY_VISION_METADATA'
- TRIMMING_H264_PICTURE_TIMING = 'TRIMMING_H264_PICTURE_TIMING'
- TRIMMING_TIME_BASED = 'TRIMMING_TIME_BASED'
- TRIMMING_TIME_CODE_TRACK = 'TRIMMING_TIME_CODE_TRACK'
bitmovin_api_sdk.models.input_stream_type_response module
- class bitmovin_api_sdk.models.input_stream_type_response.InputStreamTypeResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property type
Gets the type of this InputStreamTypeResponse.
The type of the input stream
- Returns
The type of this InputStreamTypeResponse.
- Return type
bitmovin_api_sdk.models.input_type module
- class bitmovin_api_sdk.models.input_type.InputType(value)[source]
Bases:
EnumAn enumeration.
- AKAMAI_NETSTORAGE = 'AKAMAI_NETSTORAGE'
- ASPERA = 'ASPERA'
- AZURE = 'AZURE'
- DIRECT_FILE_UPLOAD = 'DIRECT_FILE_UPLOAD'
- FTP = 'FTP'
- GCS = 'GCS'
- GCS_SERVICE_ACCOUNT = 'GCS_SERVICE_ACCOUNT'
- GENERIC_S3 = 'GENERIC_S3'
- HTTP = 'HTTP'
- HTTPS = 'HTTPS'
- LOCAL = 'LOCAL'
- REDUNDANT_RTMP = 'REDUNDANT_RTMP'
- RTMP = 'RTMP'
- S3 = 'S3'
- S3_ROLE_BASED = 'S3_ROLE_BASED'
- SFTP = 'SFTP'
- SRT = 'SRT'
- ZIXI = 'ZIXI'
bitmovin_api_sdk.models.input_type_response module
bitmovin_api_sdk.models.insertable_content module
- class bitmovin_api_sdk.models.insertable_content.InsertableContent(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property inputs
Gets the inputs of this InsertableContent.
Either a list of movie files to be inserted in the live stream or a single image file. The movie files must have a video stream at stream position 0, which matches the codec, resolution and framerate of the livestream. The number of audio streams must also be the same and they have to match the sample format, number of channels and sample rate of the audio streams of the livestream. Supported image formats are: .Y.U.V, Alias PIX, animated GIF, APNG, BMP, DPX, FITS, JPEG, JPEG 2000, JPEG-LS, PAM, PBM, PCX, PGM, PGMYUV, PNG, PPM, SGI, Sun Rasterfile, TIFF, Truevision Targa, WebP, XBM, XFace, XPM, XWD
- Returns
The inputs of this InsertableContent.
- Return type
list[InsertableContentInput]
- property openapi_types
- property status
Gets the status of this InsertableContent.
Status of the insertable content.
- Returns
The status of this InsertableContent.
- Return type
bitmovin_api_sdk.models.insertable_content_input module
- class bitmovin_api_sdk.models.insertable_content_input.InsertableContentInput(**kwargs)[source]
Bases:
object- property attribute_map
- property description
Gets the description of this InsertableContentInput.
Description of this input
- Returns
The description of this InsertableContentInput.
- Return type
string_types
- property input_id
Gets the input_id of this InsertableContentInput.
Id of the input hosting the video file (required)
- Returns
The input_id of this InsertableContentInput.
- Return type
string_types
- property input_path
Gets the input_path of this InsertableContentInput.
Path to the file on the input (required)
- Returns
The input_path of this InsertableContentInput.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.insertable_content_status module
bitmovin_api_sdk.models.interlace_filter module
- class bitmovin_api_sdk.models.interlace_filter.InterlaceFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property mode
Gets the mode of this InterlaceFilter.
- Returns
The mode of this InterlaceFilter.
- Return type
- property openapi_types
- property vertical_low_pass_filtering_mode
Gets the vertical_low_pass_filtering_mode of this InterlaceFilter.
- Returns
The vertical_low_pass_filtering_mode of this InterlaceFilter.
- Return type
bitmovin_api_sdk.models.interlace_mode module
bitmovin_api_sdk.models.invitation module
- class bitmovin_api_sdk.models.invitation.Invitation(**kwargs)[source]
Bases:
object- property attribute_map
- property company
Gets the company of this Invitation.
- Returns
The company of this Invitation.
- Return type
string_types
- property created_at
Gets the created_at of this Invitation.
Creation date of the invitation in UTC format
- Returns
The created_at of this Invitation.
- Return type
datetime
- property email
Gets the email of this Invitation.
Email address of the tenant. (required)
- Returns
The email of this Invitation.
- Return type
string_types
- property first_name
Gets the first_name of this Invitation.
- Returns
The first_name of this Invitation.
- Return type
string_types
- property id
Gets the id of this Invitation.
- Returns
The id of this Invitation.
- Return type
string_types
- property job_title
Gets the job_title of this Invitation.
- Returns
The job_title of this Invitation.
- Return type
string_types
- property last_name
Gets the last_name of this Invitation.
- Returns
The last_name of this Invitation.
- Return type
string_types
- property openapi_types
- property phone
Gets the phone of this Invitation.
- Returns
The phone of this Invitation.
- Return type
string_types
- property status
Gets the status of this Invitation.
- Returns
The status of this Invitation.
- Return type
bitmovin_api_sdk.models.invitation_status module
bitmovin_api_sdk.models.iv_size module
bitmovin_api_sdk.models.keyframe module
- class bitmovin_api_sdk.models.keyframe.Keyframe(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property openapi_types
- property time
Gets the time of this Keyframe.
Time in seconds where the keyframe should be inserted (required)
- Returns
The time of this Keyframe.
- Return type
float
bitmovin_api_sdk.models.label module
- class bitmovin_api_sdk.models.label.Label(**kwargs)[source]
Bases:
object- property attribute_map
- property id
Gets the id of this Label.
Identifier of the label.
- Returns
The id of this Label.
- Return type
int
- property lang
Gets the lang of this Label.
Specifies the language of the label.
- Returns
The lang of this Label.
- Return type
string_types
- property openapi_types
- property value
Gets the value of this Label.
Content of the label. (required)
- Returns
The value of this Label.
- Return type
string_types
bitmovin_api_sdk.models.level_h262 module
bitmovin_api_sdk.models.level_h264 module
- class bitmovin_api_sdk.models.level_h264.LevelH264(value)[source]
Bases:
EnumAn enumeration.
- L1 = '1'
- L1_1 = '1.1'
- L1_2 = '1.2'
- L1_3 = '1.3'
- L1b = '1b'
- L2 = '2'
- L2_1 = '2.1'
- L2_2 = '2.2'
- L3 = '3'
- L3_1 = '3.1'
- L3_2 = '3.2'
- L4 = '4'
- L4_1 = '4.1'
- L4_2 = '4.2'
- L5 = '5'
- L5_1 = '5.1'
- L5_2 = '5.2'
bitmovin_api_sdk.models.level_h265 module
bitmovin_api_sdk.models.limit_references module
bitmovin_api_sdk.models.limit_transform_unit_depth_recursion_mode module
bitmovin_api_sdk.models.link module
- class bitmovin_api_sdk.models.link.Link(**kwargs)[source]
Bases:
object- property attribute_map
- property href
Gets the href of this Link.
webpage target URL (required)
- Returns
The href of this Link.
- Return type
string_types
- property openapi_types
- property title
Gets the title of this Link.
Short description of the linked page
- Returns
The title of this Link.
- Return type
string_types
bitmovin_api_sdk.models.live_auto_shutdown_configuration module
- class bitmovin_api_sdk.models.live_auto_shutdown_configuration.LiveAutoShutdownConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property bytes_read_timeout_seconds
Gets the bytes_read_timeout_seconds of this LiveAutoShutdownConfiguration.
Automatically shutdown the live stream if there is no input anymore for a predefined number of seconds.
- Returns
The bytes_read_timeout_seconds of this LiveAutoShutdownConfiguration.
- Return type
int
- property openapi_types
- property stream_timeout_minutes
Gets the stream_timeout_minutes of this LiveAutoShutdownConfiguration.
Automatically shutdown the live stream after a predefined runtime in minutes.
- Returns
The stream_timeout_minutes of this LiveAutoShutdownConfiguration.
- Return type
int
- property waiting_for_first_connect_timeout_minutes
Gets the waiting_for_first_connect_timeout_minutes of this LiveAutoShutdownConfiguration.
Automatically shutdown the live stream if input is never connected for a predefined number of minutes.
- Returns
The waiting_for_first_connect_timeout_minutes of this LiveAutoShutdownConfiguration.
- Return type
int
bitmovin_api_sdk.models.live_dash_manifest module
- class bitmovin_api_sdk.models.live_dash_manifest.LiveDashManifest(**kwargs)[source]
Bases:
object- property attribute_map
- property availability_start_time_mode
Gets the availability_start_time_mode of this LiveDashManifest.
The mode to trigger the availabilityStartTime initialization.
- Returns
The availability_start_time_mode of this LiveDashManifest.
- Return type
- property live_edge_offset
Gets the live_edge_offset of this LiveDashManifest.
Live edge offset in seconds
- Returns
The live_edge_offset of this LiveDashManifest.
- Return type
float
- property manifest_id
Gets the manifest_id of this LiveDashManifest.
Dash manifest id (required)
- Returns
The manifest_id of this LiveDashManifest.
- Return type
string_types
- property minimum_update_period
Gets the minimum_update_period of this LiveDashManifest.
The minimumUpdatePeriod to be set in the DASH manifest. If nothing is set, the segment duration will be set.
- Returns
The minimum_update_period of this LiveDashManifest.
- Return type
float
- property openapi_types
- property suggested_presentation_delay
Gets the suggested_presentation_delay of this LiveDashManifest.
The suggestedPresentationDelay to be set in the DASH manifest. If nothing is set, no value will be set.
- Returns
The suggested_presentation_delay of this LiveDashManifest.
- Return type
float
- property timeshift
Gets the timeshift of this LiveDashManifest.
Timeshift in seconds
- Returns
The timeshift of this LiveDashManifest.
- Return type
float
bitmovin_api_sdk.models.live_encoding module
- class bitmovin_api_sdk.models.live_encoding.LiveEncoding(**kwargs)[source]
Bases:
object- property application
Gets the application of this LiveEncoding.
This will indicate the application ‘live’
- Returns
The application of this LiveEncoding.
- Return type
string_types
- property attribute_map
- property encoder_ip
Gets the encoder_ip of this LiveEncoding.
IP address of the live encoder (required)
- Returns
The encoder_ip of this LiveEncoding.
- Return type
string_types
- property openapi_types
- property stream_key
Gets the stream_key of this LiveEncoding.
Stream key of the live encoder (required)
- Returns
The stream_key of this LiveEncoding.
- Return type
string_types
bitmovin_api_sdk.models.live_encoding_codec module
bitmovin_api_sdk.models.live_encoding_event_name module
bitmovin_api_sdk.models.live_encoding_heartbeat_webhook module
- class bitmovin_api_sdk.models.live_encoding_heartbeat_webhook.LiveEncodingHeartbeatWebhook(**kwargs)[source]
Bases:
Webhook- property attribute_map
- property interval
Gets the interval of this LiveEncodingHeartbeatWebhook.
The interval of the heartbeat in seconds.
- Returns
The interval of this LiveEncodingHeartbeatWebhook.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.live_encoding_options_statistics module
- class bitmovin_api_sdk.models.live_encoding_options_statistics.LiveEncodingOptionsStatistics(**kwargs)[source]
Bases:
object- property attribute_map
- property encoding_id
Gets the encoding_id of this LiveEncodingOptionsStatistics.
The ID of the encoding (required)
- Returns
The encoding_id of this LiveEncodingOptionsStatistics.
- Return type
string_types
- property openapi_types
- property type
Gets the type of this LiveEncodingOptionsStatistics.
- Returns
The type of this LiveEncodingOptionsStatistics.
- Return type
- property units_used
Gets the units_used of this LiveEncodingOptionsStatistics.
Live option units used (required)
- Returns
The units_used of this LiveEncodingOptionsStatistics.
- Return type
float
bitmovin_api_sdk.models.live_encoding_stats module
- class bitmovin_api_sdk.models.live_encoding_stats.LiveEncodingStats(**kwargs)[source]
Bases:
object- property attribute_map
- property events
Gets the events of this LiveEncodingStats.
List of events
- Returns
The events of this LiveEncodingStats.
- Return type
list[LiveEncodingStatsEvent]
- property openapi_types
- property statistics
Gets the statistics of this LiveEncodingStats.
List of statistics
- Returns
The statistics of this LiveEncodingStats.
- Return type
list[StreamInfos]
- property status
Gets the status of this LiveEncodingStats.
- Returns
The status of this LiveEncodingStats.
- Return type
bitmovin_api_sdk.models.live_encoding_stats_event module
- class bitmovin_api_sdk.models.live_encoding_stats_event.LiveEncodingStatsEvent(**kwargs)[source]
Bases:
object- property attribute_map
- property details
Gets the details of this LiveEncodingStatsEvent.
- Returns
The details of this LiveEncodingStatsEvent.
- Return type
- property openapi_types
- property time
Gets the time of this LiveEncodingStatsEvent.
Timestamp of the event, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)
- Returns
The time of this LiveEncodingStatsEvent.
- Return type
datetime
bitmovin_api_sdk.models.live_encoding_stats_event_details module
- class bitmovin_api_sdk.models.live_encoding_stats_event_details.LiveEncodingStatsEventDetails(**kwargs)[source]
Bases:
object- property attribute_map
- property duration_in_seconds
Gets the duration_in_seconds of this LiveEncodingStatsEventDetails.
Duration in seconds
- Returns
The duration_in_seconds of this LiveEncodingStatsEventDetails.
- Return type
float
- property event_type
Gets the event_type of this LiveEncodingStatsEventDetails.
- Returns
The event_type of this LiveEncodingStatsEventDetails.
- Return type
- property message
Gets the message of this LiveEncodingStatsEventDetails.
Short description of the event
- Returns
The message of this LiveEncodingStatsEventDetails.
- Return type
string_types
- property mid_roll_asset_names
Gets the mid_roll_asset_names of this LiveEncodingStatsEventDetails.
Name of the mid roll asset name
- Returns
The mid_roll_asset_names of this LiveEncodingStatsEventDetails.
- Return type
list[string_types]
- property openapi_types
bitmovin_api_sdk.models.live_encoding_status module
bitmovin_api_sdk.models.live_hls_manifest module
- class bitmovin_api_sdk.models.live_hls_manifest.LiveHlsManifest(**kwargs)[source]
Bases:
object- property ad_marker_settings
Gets the ad_marker_settings of this LiveHlsManifest.
Configuration for tags related to ad markers (e.g. Scte35)
- Returns
The ad_marker_settings of this LiveHlsManifest.
- Return type
- property attribute_map
- property insert_program_date_time
Gets the insert_program_date_time of this LiveHlsManifest.
Specifies if the EXT-X-PROGRAM-DATETIME tag will be included
- Returns
The insert_program_date_time of this LiveHlsManifest.
- Return type
bool
- property live_edge_offset
Gets the live_edge_offset of this LiveHlsManifest.
Live edge offset in seconds
- Returns
The live_edge_offset of this LiveHlsManifest.
- Return type
float
- property manifest_id
Gets the manifest_id of this LiveHlsManifest.
HLS manifest id (required)
- Returns
The manifest_id of this LiveHlsManifest.
- Return type
string_types
- property openapi_types
- property program_date_time_settings
Gets the program_date_time_settings of this LiveHlsManifest.
Configuration for the EXT-X-PROGRAM-DATETIME tag
- Returns
The program_date_time_settings of this LiveHlsManifest.
- Return type
- property timeshift
Gets the timeshift of this LiveHlsManifest.
Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.
- Returns
The timeshift of this LiveHlsManifest.
- Return type
float
bitmovin_api_sdk.models.live_media_ingest_output module
- class bitmovin_api_sdk.models.live_media_ingest_output.LiveMediaIngestOutput(**kwargs)[source]
Bases:
Output- property attribute_map
- property openapi_types
- property publishing_point
Gets the publishing_point of this LiveMediaIngestOutput.
URL specifying the publishing point for the output. Can use either http or https. (required)
- Returns
The publishing_point of this LiveMediaIngestOutput.
- Return type
string_types
bitmovin_api_sdk.models.live_options_breakdown_entry module
- class bitmovin_api_sdk.models.live_options_breakdown_entry.LiveOptionsBreakdownEntry(**kwargs)[source]
Bases:
object- property attribute_map
- property date
Gets the date of this LiveOptionsBreakdownEntry.
Date, format: yyyy-MM-dd (required)
- Returns
The date of this LiveOptionsBreakdownEntry.
- Return type
date
- property hd
Gets the hd of this LiveOptionsBreakdownEntry.
- Returns
The hd of this LiveOptionsBreakdownEntry.
- Return type
- property openapi_types
bitmovin_api_sdk.models.live_options_entry module
- class bitmovin_api_sdk.models.live_options_entry.LiveOptionsEntry(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property units_used
Gets the units_used of this LiveOptionsEntry.
Live option units used (required)
- Returns
The units_used of this LiveOptionsEntry.
- Return type
int
bitmovin_api_sdk.models.live_options_statistics module
- class bitmovin_api_sdk.models.live_options_statistics.LiveOptionsStatistics(**kwargs)[source]
Bases:
object- property attribute_map
- property breakdown
Gets the breakdown of this LiveOptionsStatistics.
Live options statistics aggregated per day (required)
- Returns
The breakdown of this LiveOptionsStatistics.
- Return type
- property openapi_types
- property summary
Gets the summary of this LiveOptionsStatistics.
- Returns
The summary of this LiveOptionsStatistics.
- Return type
bitmovin_api_sdk.models.live_options_summary module
bitmovin_api_sdk.models.live_options_type module
bitmovin_api_sdk.models.live_standby_pool_details module
- class bitmovin_api_sdk.models.live_standby_pool_details.LiveStandbyPoolDetails(**kwargs)[source]
Bases:
LiveStandbyPoolResponse- property attribute_map
- property encoding_template
Gets the encoding_template of this LiveStandbyPoolDetails.
Base64 encoded template used to start the encodings in the pool
- Returns
The encoding_template of this LiveStandbyPoolDetails.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.live_standby_pool_encoding module
- class bitmovin_api_sdk.models.live_standby_pool_encoding.LiveStandbyPoolEncoding(**kwargs)[source]
Bases:
object- property attribute_map
- property created_at
Gets the created_at of this LiveStandbyPoolEncoding.
- Returns
The created_at of this LiveStandbyPoolEncoding.
- Return type
string_types
- property encoding_id
Gets the encoding_id of this LiveStandbyPoolEncoding.
ID of the encoding that ready for ingest in the standby pool
- Returns
The encoding_id of this LiveStandbyPoolEncoding.
- Return type
string_types
- property id
Gets the id of this LiveStandbyPoolEncoding.
- Returns
The id of this LiveStandbyPoolEncoding.
- Return type
string_types
- property ingest_points
Gets the ingest_points of this LiveStandbyPoolEncoding.
- Returns
The ingest_points of this LiveStandbyPoolEncoding.
- Return type
- property manifests
Gets the manifests of this LiveStandbyPoolEncoding.
- Returns
The manifests of this LiveStandbyPoolEncoding.
- Return type
- property modified_at
Gets the modified_at of this LiveStandbyPoolEncoding.
- Returns
The modified_at of this LiveStandbyPoolEncoding.
- Return type
string_types
- property openapi_types
- property status
Gets the status of this LiveStandbyPoolEncoding.
- Returns
The status of this LiveStandbyPoolEncoding.
- Return type
bitmovin_api_sdk.models.live_standby_pool_encoding_ingest_point module
- class bitmovin_api_sdk.models.live_standby_pool_encoding_ingest_point.LiveStandbyPoolEncodingIngestPoint(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property stream_base_url
Gets the stream_base_url of this LiveStandbyPoolEncodingIngestPoint.
URL to the RTMP/RTMPS endpoint for this live encoding
- Returns
The stream_base_url of this LiveStandbyPoolEncodingIngestPoint.
- Return type
string_types
- property stream_key
Gets the stream_key of this LiveStandbyPoolEncodingIngestPoint.
Stream key value of this live encoding
- Returns
The stream_key of this LiveStandbyPoolEncodingIngestPoint.
- Return type
string_types
bitmovin_api_sdk.models.live_standby_pool_encoding_manifest module
- class bitmovin_api_sdk.models.live_standby_pool_encoding_manifest.LiveStandbyPoolEncodingManifest(**kwargs)[source]
Bases:
object- property attribute_map
- property manifest_id
Gets the manifest_id of this LiveStandbyPoolEncodingManifest.
ID of the manifest that was created for the encoding
- Returns
The manifest_id of this LiveStandbyPoolEncodingManifest.
- Return type
string_types
- property openapi_types
- property type
Gets the type of this LiveStandbyPoolEncodingManifest.
- Returns
The type of this LiveStandbyPoolEncodingManifest.
- Return type
- property url
Gets the url of this LiveStandbyPoolEncodingManifest.
URL to the manifest
- Returns
The url of this LiveStandbyPoolEncodingManifest.
- Return type
string_types
bitmovin_api_sdk.models.live_standby_pool_encoding_manifest_type module
bitmovin_api_sdk.models.live_standby_pool_encoding_status module
- class bitmovin_api_sdk.models.live_standby_pool_encoding_status.LiveStandbyPoolEncodingStatus(value)[source]
Bases:
EnumAn enumeration.
- ACQUIRED = 'ACQUIRED'
- CREATING = 'CREATING'
- DELETING = 'DELETING'
- ERROR = 'ERROR'
- PREPARING = 'PREPARING'
- READY = 'READY'
- TO_BE_CREATED = 'TO_BE_CREATED'
- TO_BE_DELETED = 'TO_BE_DELETED'
bitmovin_api_sdk.models.live_standby_pool_event_log module
- class bitmovin_api_sdk.models.live_standby_pool_event_log.LiveStandbyPoolEventLog(**kwargs)[source]
Bases:
object- property attribute_map
- property created_at
Gets the created_at of this LiveStandbyPoolEventLog.
Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this LiveStandbyPoolEventLog.
- Return type
string_types
- property details
Gets the details of this LiveStandbyPoolEventLog.
Detailed description, payloads, hints on how to resolve errors, etc
- Returns
The details of this LiveStandbyPoolEventLog.
- Return type
string_types
- property event_type
Gets the event_type of this LiveStandbyPoolEventLog.
- Returns
The event_type of this LiveStandbyPoolEventLog.
- Return type
- property id
Gets the id of this LiveStandbyPoolEventLog.
UUID of the entry
- Returns
The id of this LiveStandbyPoolEventLog.
- Return type
string_types
- property message
Gets the message of this LiveStandbyPoolEventLog.
Short description of the event
- Returns
The message of this LiveStandbyPoolEventLog.
- Return type
string_types
- property openapi_types
- property standby_pool_encoding_id
Gets the standby_pool_encoding_id of this LiveStandbyPoolEventLog.
(Optional) Id of the standby pool encoding associated with the event
- Returns
The standby_pool_encoding_id of this LiveStandbyPoolEventLog.
- Return type
string_types
- property standby_pool_id
Gets the standby_pool_id of this LiveStandbyPoolEventLog.
Id of the standby_pool associated with the event log
- Returns
The standby_pool_id of this LiveStandbyPoolEventLog.
- Return type
string_types
bitmovin_api_sdk.models.live_standby_pool_event_log_type module
bitmovin_api_sdk.models.live_standby_pool_request module
- class bitmovin_api_sdk.models.live_standby_pool_request.LiveStandbyPoolRequest(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property encoding_template
Gets the encoding_template of this LiveStandbyPoolRequest.
Base64 encoded template used to start the encodings in the pool (required)
- Returns
The encoding_template of this LiveStandbyPoolRequest.
- Return type
string_types
- property openapi_types
- property target_pool_size
Gets the target_pool_size of this LiveStandbyPoolRequest.
Number of instances to keep ready for streaming while the pool is running (required)
- Returns
The target_pool_size of this LiveStandbyPoolRequest.
- Return type
int
bitmovin_api_sdk.models.live_standby_pool_response module
- class bitmovin_api_sdk.models.live_standby_pool_response.LiveStandbyPoolResponse(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property encoding_template_name
Gets the encoding_template_name of this LiveStandbyPoolResponse.
The name of the encoding template used with this Standby Pool
- Returns
The encoding_template_name of this LiveStandbyPoolResponse.
- Return type
string_types
- property error_encodings
Gets the error_encodings of this LiveStandbyPoolResponse.
Number of instances currently in error state in the pool
- Returns
The error_encodings of this LiveStandbyPoolResponse.
- Return type
int
- property openapi_types
- property pool_status
Gets the pool_status of this LiveStandbyPoolResponse.
- Returns
The pool_status of this LiveStandbyPoolResponse.
- Return type
- property preparing_encodings
Gets the preparing_encodings of this LiveStandbyPoolResponse.
Number of instances currently being prepared in the pool
- Returns
The preparing_encodings of this LiveStandbyPoolResponse.
- Return type
int
- property ready_encodings
Gets the ready_encodings of this LiveStandbyPoolResponse.
Number of instances currently in ready state in the pool
- Returns
The ready_encodings of this LiveStandbyPoolResponse.
- Return type
int
- property target_pool_size
Gets the target_pool_size of this LiveStandbyPoolResponse.
Number of instances to keep ready for streaming while the pool is running (required)
- Returns
The target_pool_size of this LiveStandbyPoolResponse.
- Return type
int
bitmovin_api_sdk.models.live_standby_pool_status module
bitmovin_api_sdk.models.live_standby_pool_update module
- class bitmovin_api_sdk.models.live_standby_pool_update.LiveStandbyPoolUpdate(**kwargs)[source]
Bases:
object- property attribute_map
- property encoding_template
Gets the encoding_template of this LiveStandbyPoolUpdate.
Base64 encoded template used to start the encodings in the pool
- Returns
The encoding_template of this LiveStandbyPoolUpdate.
- Return type
string_types
- property openapi_types
- property target_pool_size
Gets the target_pool_size of this LiveStandbyPoolUpdate.
Number of instances to keep ready for streaming while the pool is running
- Returns
The target_pool_size of this LiveStandbyPoolUpdate.
- Return type
int
bitmovin_api_sdk.models.local_input module
bitmovin_api_sdk.models.local_output module
bitmovin_api_sdk.models.manifest module
- class bitmovin_api_sdk.models.manifest.Manifest(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property openapi_types
- property outputs
Gets the outputs of this Manifest.
The outputs to store the manifest (required)
- Returns
The outputs of this Manifest.
- Return type
list[EncodingOutput]
- property status
Gets the status of this Manifest.
Current status
- Returns
The status of this Manifest.
- Return type
- property type
Gets the type of this Manifest.
- Returns
The type of this Manifest.
- Return type
bitmovin_api_sdk.models.manifest_generator module
bitmovin_api_sdk.models.manifest_resource module
- class bitmovin_api_sdk.models.manifest_resource.ManifestResource(**kwargs)[source]
Bases:
object- property attribute_map
- property manifest_id
Gets the manifest_id of this ManifestResource.
Id of the manifest resource (required)
- Returns
The manifest_id of this ManifestResource.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.manifest_type module
bitmovin_api_sdk.models.manifest_type_response module
bitmovin_api_sdk.models.marketplace module
bitmovin_api_sdk.models.marlin_drm module
- class bitmovin_api_sdk.models.marlin_drm.MarlinDrm(**kwargs)[source]
Bases:
Drm- property attribute_map
- property key
Gets the key of this MarlinDrm.
16 byte key in hex (32 characters) (required)
- Returns
The key of this MarlinDrm.
- Return type
string_types
- property kid
Gets the kid of this MarlinDrm.
16 byte key in hex (32 characters) (required)
- Returns
The kid of this MarlinDrm.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.max_ctu_size module
bitmovin_api_sdk.models.max_transform_unit_size module
bitmovin_api_sdk.models.media_config_bitrate module
bitmovin_api_sdk.models.media_info_type module
bitmovin_api_sdk.models.media_info_type_response module
- class bitmovin_api_sdk.models.media_info_type_response.MediaInfoTypeResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property type
Gets the type of this MediaInfoTypeResponse.
The type of the media-info
- Returns
The type of this MediaInfoTypeResponse.
- Return type
bitmovin_api_sdk.models.media_stream module
- class bitmovin_api_sdk.models.media_stream.MediaStream(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property codec
Gets the codec of this MediaStream.
Codec of the stream
- Returns
The codec of this MediaStream.
- Return type
string_types
- property duration
Gets the duration of this MediaStream.
Duration of the stream in seconds
- Returns
The duration of this MediaStream.
- Return type
float
- property openapi_types
- property position
Gets the position of this MediaStream.
Position of the stream in the media, starting from 0.
- Returns
The position of this MediaStream.
- Return type
int
bitmovin_api_sdk.models.media_type module
bitmovin_api_sdk.models.message module
- class bitmovin_api_sdk.models.message.Message(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property date
Gets the date of this Message.
Timestamp when the message occurred
- Returns
The date of this Message.
- Return type
datetime
- property field
Gets the field of this Message.
Name of the field to which the message is referring to
- Returns
The field of this Message.
- Return type
string_types
- property links
Gets the links of this Message.
collection of links to webpages containing further information on the topic
- Returns
The links of this Message.
- Return type
list[Link]
- property more
Gets the more of this Message.
Service-specific information
- Returns
The more of this Message.
- Return type
object
- property openapi_types
- property text
Gets the text of this Message.
Message text (required)
- Returns
The text of this Message.
- Return type
string_types
- property type
Gets the type of this Message.
Message type giving a hint on the importance of the message (log level) (required)
- Returns
The type of this Message.
- Return type
bitmovin_api_sdk.models.message_type module
bitmovin_api_sdk.models.min_coding_unit_size module
bitmovin_api_sdk.models.mjpeg_video_configuration module
- class bitmovin_api_sdk.models.mjpeg_video_configuration.MjpegVideoConfiguration(**kwargs)[source]
Bases:
CodecConfiguration- property attribute_map
- property height
Gets the height of this MjpegVideoConfiguration.
Height of the encoded video
- Returns
The height of this MjpegVideoConfiguration.
- Return type
int
- property openapi_types
- property pixel_format
Gets the pixel_format of this MjpegVideoConfiguration.
- Returns
The pixel_format of this MjpegVideoConfiguration.
- Return type
- property q_scale
Gets the q_scale of this MjpegVideoConfiguration.
The quality scale parameter (required)
- Returns
The q_scale of this MjpegVideoConfiguration.
- Return type
int
- property rate
Gets the rate of this MjpegVideoConfiguration.
Target frame rate of the encoded video! (required)
- Returns
The rate of this MjpegVideoConfiguration.
- Return type
float
- property width
Gets the width of this MjpegVideoConfiguration.
Width of the encoded video
- Returns
The width of this MjpegVideoConfiguration.
- Return type
int
bitmovin_api_sdk.models.motion_search module
bitmovin_api_sdk.models.mp2_audio_configuration module
- class bitmovin_api_sdk.models.mp2_audio_configuration.Mp2AudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this Mp2AudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this Mp2AudioConfiguration.
- Return type
- property openapi_types
bitmovin_api_sdk.models.mp3_audio_configuration module
- class bitmovin_api_sdk.models.mp3_audio_configuration.Mp3AudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this Mp3AudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this Mp3AudioConfiguration.
- Return type
- property openapi_types
bitmovin_api_sdk.models.mp3_muxing module
bitmovin_api_sdk.models.mp3_muxing_information module
bitmovin_api_sdk.models.mp4_muxing module
- class bitmovin_api_sdk.models.mp4_muxing.Mp4Muxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property dolby_vision_configuration
Gets the dolby_vision_configuration of this Mp4Muxing.
Dolby Vision specific configuration
- Returns
The dolby_vision_configuration of this Mp4Muxing.
- Return type
- property filename
Gets the filename of this Mp4Muxing.
Name of the output file (either filename or name is required, prefer filename)
- Returns
The filename of this Mp4Muxing.
- Return type
string_types
- property fragment_duration
Gets the fragment_duration of this Mp4Muxing.
Duration of fragments in milliseconds. Required for Fragmented MP4 Muxing (for Smooth Streaming or DASH On-Demand). Not setting this will result in unfragmented mp4.
- Returns
The fragment_duration of this Mp4Muxing.
- Return type
int
- property fragmented_mp4_muxing_manifest_type
Gets the fragmented_mp4_muxing_manifest_type of this Mp4Muxing.
- Returns
The fragmented_mp4_muxing_manifest_type of this Mp4Muxing.
- Return type
- property openapi_types
bitmovin_api_sdk.models.mp4_muxing_information module
bitmovin_api_sdk.models.muxing module
- class bitmovin_api_sdk.models.muxing.Muxing(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property avg_bitrate
Gets the avg_bitrate of this Muxing.
Average bitrate. Available after encoding finishes.
- Returns
The avg_bitrate of this Muxing.
- Return type
int
- discriminator_value_class_map = {'BROADCAST_TS': 'BroadcastTsMuxing', 'CHUNKED_TEXT': 'ChunkedTextMuxing', 'CMAF': 'CmafMuxing', 'FMP4': 'Fmp4Muxing', 'MP3': 'Mp3Muxing', 'MP4': 'Mp4Muxing', 'MXF': 'MxfMuxing', 'PACKED_AUDIO': 'PackedAudioMuxing', 'PROGRESSIVE_MOV': 'ProgressiveMovMuxing', 'PROGRESSIVE_TS': 'ProgressiveTsMuxing', 'PROGRESSIVE_WAV': 'ProgressiveWavMuxing', 'PROGRESSIVE_WEBM': 'ProgressiveWebmMuxing', 'SEGMENTED_RAW': 'SegmentedRawMuxing', 'TEXT': 'TextMuxing', 'TS': 'TsMuxing', 'WEBM': 'WebmMuxing'}
- property ignored_by
Gets the ignored_by of this Muxing.
This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its ‘streamConditionsMode’
- Returns
The ignored_by of this Muxing.
- Return type
list[Ignoring]
- property max_bitrate
Gets the max_bitrate of this Muxing.
Max bitrate. Available after encoding finishes.
- Returns
The max_bitrate of this Muxing.
- Return type
int
- property min_bitrate
Gets the min_bitrate of this Muxing.
Min bitrate. Available after encoding finishes.
- Returns
The min_bitrate of this Muxing.
- Return type
int
- property openapi_types
- property outputs
Gets the outputs of this Muxing.
- Returns
The outputs of this Muxing.
- Return type
list[EncodingOutput]
- property stream_conditions_mode
Gets the stream_conditions_mode of this Muxing.
Specifies how to proceed with the Muxing when some of its Streams are ignored (see ‘condition’ property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, ‘ignoredBy’ will indicate if and why it has been ignored.
- Returns
The stream_conditions_mode of this Muxing.
- Return type
- property streams
Gets the streams of this Muxing.
- Returns
The streams of this Muxing.
- Return type
list[MuxingStream]
bitmovin_api_sdk.models.muxing_information_audio_track module
- class bitmovin_api_sdk.models.muxing_information_audio_track.MuxingInformationAudioTrack(**kwargs)[source]
Bases:
object- property attribute_map
- property bit_rate
Gets the bit_rate of this MuxingInformationAudioTrack.
The bitrate of the audio track
- Returns
The bit_rate of this MuxingInformationAudioTrack.
- Return type
int
- property channels
Gets the channels of this MuxingInformationAudioTrack.
The number of channels in this audio stream
- Returns
The channels of this MuxingInformationAudioTrack.
- Return type
int
- property codec
Gets the codec of this MuxingInformationAudioTrack.
The codec used for the track
- Returns
The codec of this MuxingInformationAudioTrack.
- Return type
string_types
- property codec_iso
Gets the codec_iso of this MuxingInformationAudioTrack.
The codec string of the track
- Returns
The codec_iso of this MuxingInformationAudioTrack.
- Return type
string_types
- property duration
Gets the duration of this MuxingInformationAudioTrack.
The duration in seconds
- Returns
The duration of this MuxingInformationAudioTrack.
- Return type
float
- property index
Gets the index of this MuxingInformationAudioTrack.
The stream index in the container
- Returns
The index of this MuxingInformationAudioTrack.
- Return type
int
- property openapi_types
- property rate
Gets the rate of this MuxingInformationAudioTrack.
- Returns
The rate of this MuxingInformationAudioTrack.
- Return type
int
- property sample_rate
Gets the sample_rate of this MuxingInformationAudioTrack.
The sampling rate of the audio stream
- Returns
The sample_rate of this MuxingInformationAudioTrack.
- Return type
int
bitmovin_api_sdk.models.muxing_information_video_track module
- class bitmovin_api_sdk.models.muxing_information_video_track.MuxingInformationVideoTrack(**kwargs)[source]
Bases:
object- property aspect_ratio
Gets the aspect_ratio of this MuxingInformationVideoTrack.
The aspect ratio of the stream
- Returns
The aspect_ratio of this MuxingInformationVideoTrack.
- Return type
string_types
- property attribute_map
- property bit_rate
Gets the bit_rate of this MuxingInformationVideoTrack.
The bitrate of the video track
- Returns
The bit_rate of this MuxingInformationVideoTrack.
- Return type
int
- property codec
Gets the codec of this MuxingInformationVideoTrack.
The codec used for the track
- Returns
The codec of this MuxingInformationVideoTrack.
- Return type
string_types
- property codec_iso
Gets the codec_iso of this MuxingInformationVideoTrack.
The codec string of the track
- Returns
The codec_iso of this MuxingInformationVideoTrack.
- Return type
string_types
- property duration
Gets the duration of this MuxingInformationVideoTrack.
The duration in seconds
- Returns
The duration of this MuxingInformationVideoTrack.
- Return type
float
- property frame_height
Gets the frame_height of this MuxingInformationVideoTrack.
The height of the frame in pixel
- Returns
The frame_height of this MuxingInformationVideoTrack.
- Return type
int
- property frame_mode
Gets the frame_mode of this MuxingInformationVideoTrack.
The frame mode (e.g. progressive)
- Returns
The frame_mode of this MuxingInformationVideoTrack.
- Return type
string_types
- property frame_rate
Gets the frame_rate of this MuxingInformationVideoTrack.
The frame rate of the stream in fractional format
- Returns
The frame_rate of this MuxingInformationVideoTrack.
- Return type
string_types
- property frame_width
Gets the frame_width of this MuxingInformationVideoTrack.
The width of the frame in pixel
- Returns
The frame_width of this MuxingInformationVideoTrack.
- Return type
int
- property index
Gets the index of this MuxingInformationVideoTrack.
The stream index in the container
- Returns
The index of this MuxingInformationVideoTrack.
- Return type
int
- property number_of_frames
Gets the number_of_frames of this MuxingInformationVideoTrack.
The number of frames of that video track
- Returns
The number_of_frames of this MuxingInformationVideoTrack.
- Return type
int
- property openapi_types
- property pixel_format
Gets the pixel_format of this MuxingInformationVideoTrack.
The pixel format used
- Returns
The pixel_format of this MuxingInformationVideoTrack.
- Return type
string_types
- property rate
Gets the rate of this MuxingInformationVideoTrack.
- Returns
The rate of this MuxingInformationVideoTrack.
- Return type
int
- property start_time
Gets the start_time of this MuxingInformationVideoTrack.
The start time in seconds
- Returns
The start_time of this MuxingInformationVideoTrack.
- Return type
float
bitmovin_api_sdk.models.muxing_stream module
bitmovin_api_sdk.models.muxing_type module
- class bitmovin_api_sdk.models.muxing_type.MuxingType(value)[source]
Bases:
EnumAn enumeration.
- BROADCAST_TS = 'BROADCAST_TS'
- CHUNKED_TEXT = 'CHUNKED_TEXT'
- CMAF = 'CMAF'
- FMP4 = 'FMP4'
- MP3 = 'MP3'
- MP4 = 'MP4'
- MXF = 'MXF'
- PACKED_AUDIO = 'PACKED_AUDIO'
- PROGRESSIVE_MOV = 'PROGRESSIVE_MOV'
- PROGRESSIVE_TS = 'PROGRESSIVE_TS'
- PROGRESSIVE_WAV = 'PROGRESSIVE_WAV'
- PROGRESSIVE_WEBM = 'PROGRESSIVE_WEBM'
- SEGMENTED_RAW = 'SEGMENTED_RAW'
- TEXT = 'TEXT'
- TS = 'TS'
- WEBM = 'WEBM'
bitmovin_api_sdk.models.muxing_type_response module
bitmovin_api_sdk.models.mv_prediction_mode module
bitmovin_api_sdk.models.mxf_muxing module
bitmovin_api_sdk.models.nex_guard_ab_watermarking_feature module
bitmovin_api_sdk.models.nex_guard_file_marker module
- class bitmovin_api_sdk.models.nex_guard_file_marker.NexGuardFileMarker(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property license
Gets the license of this NexGuardFileMarker.
Use the base64 license string that Nagra provides you. (required)
- Returns
The license of this NexGuardFileMarker.
- Return type
string_types
- property openapi_types
- property payload
Gets the payload of this NexGuardFileMarker.
Specify the payload ID that you want to be associated with this output. Valid values vary depending on your Nagra NexGuard forensic watermarking workflow. For PreRelease Content (NGPR), specify an integer from 1 through 4,194,303. You must generate a unique ID for each asset you watermark, and keep a record of th ID. Neither Nagra nor Bitmovin keep track of this for you.
- Returns
The payload of this NexGuardFileMarker.
- Return type
int
- property preset
Gets the preset of this NexGuardFileMarker.
Enter one of the watermarking preset strings that Nagra provides you.
- Returns
The preset of this NexGuardFileMarker.
- Return type
string_types
- property strength
Gets the strength of this NexGuardFileMarker.
Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don’t specify a value here, the Nagra NexGuard library uses its default value.
- Returns
The strength of this NexGuardFileMarker.
- Return type
- property watermark_type
Gets the watermark_type of this NexGuardFileMarker.
The type of watermarking to be used: * OTT - A/B watermarking (for video streams only) * DUPLICATED - Stream duplication to match A/B video streams in CDN delivery (for audio streams only)
- Returns
The watermark_type of this NexGuardFileMarker.
- Return type
bitmovin_api_sdk.models.nex_guard_watermarking_strength module
bitmovin_api_sdk.models.nex_guard_watermarking_type module
bitmovin_api_sdk.models.notification module
- class bitmovin_api_sdk.models.notification.Notification(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property category
Gets the category of this Notification.
- Returns
The category of this Notification.
- Return type
string_types
- property custom_data
Gets the custom_data of this Notification.
User-specific meta data. This can hold anything.
- Returns
The custom_data of this Notification.
- Return type
dict(str, object)
- property event_type
Gets the event_type of this Notification.
- Returns
The event_type of this Notification.
- Return type
string_types
- property muted
Gets the muted of this Notification.
- Returns
The muted of this Notification.
- Return type
bool
- property openapi_types
- property resolve
Gets the resolve of this Notification.
Notify when condition resolves after it was met
- Returns
The resolve of this Notification.
- Return type
bool
- property resource_id
Gets the resource_id of this Notification.
Specific resource, e.g. encoding id
- Returns
The resource_id of this Notification.
- Return type
string_types
- property resource_type
Gets the resource_type of this Notification.
- Returns
The resource_type of this Notification.
- Return type
string_types
- property triggered_at
Gets the triggered_at of this Notification.
Last time the notification was triggered
- Returns
The triggered_at of this Notification.
- Return type
datetime
- property type
Gets the type of this Notification.
- Returns
The type of this Notification.
- Return type
string_types
bitmovin_api_sdk.models.notification_state_entry module
- class bitmovin_api_sdk.models.notification_state_entry.NotificationStateEntry(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property muted
Gets the muted of this NotificationStateEntry.
Indicate if notification was sent (required)
- Returns
The muted of this NotificationStateEntry.
- Return type
bool
- property notification_id
Gets the notification_id of this NotificationStateEntry.
The notification this state belongs to (required)
- Returns
The notification_id of this NotificationStateEntry.
- Return type
string_types
- property openapi_types
- property resource_id
Gets the resource_id of this NotificationStateEntry.
Indicate if triggered for specific resource (required)
- Returns
The resource_id of this NotificationStateEntry.
- Return type
string_types
- property state
Gets the state of this NotificationStateEntry.
- Returns
The state of this NotificationStateEntry.
- Return type
- property triggered_at
Gets the triggered_at of this NotificationStateEntry.
- Returns
The triggered_at of this NotificationStateEntry.
- Return type
datetime
bitmovin_api_sdk.models.notification_states module
bitmovin_api_sdk.models.opus_audio_configuration module
- class bitmovin_api_sdk.models.opus_audio_configuration.OpusAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this OpusAudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this OpusAudioConfiguration.
- Return type
- property openapi_types
bitmovin_api_sdk.models.opus_channel_layout module
- class bitmovin_api_sdk.models.opus_channel_layout.OpusChannelLayout(value)[source]
Bases:
EnumAn enumeration.
- CL_4_1 = '4.1'
- CL_5_0_BACK = '5.0_BACK'
- CL_6_1 = '6.1'
- CL_7_1 = '7.1'
- CL_QUAD = 'QUAD'
- CL_STEREO = 'STEREO'
- CL_SURROUND = 'SURROUND'
- MONO = 'MONO'
- NONE = 'NONE'
- XCL_5_1_BACK = '5.1_BACK'
bitmovin_api_sdk.models.or_conjunction module
bitmovin_api_sdk.models.organization module
- class bitmovin_api_sdk.models.organization.Organization(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property label_color
Gets the label_color of this Organization.
Hexadecimal color
- Returns
The label_color of this Organization.
- Return type
string_types
- property limits_per_resource
Gets the limits_per_resource of this Organization.
- Returns
The limits_per_resource of this Organization.
- Return type
list[ResourceLimitContainer]
- property mfa_required
Gets the mfa_required of this Organization.
Flag indicating if MFA is required for the organization
- Returns
The mfa_required of this Organization.
- Return type
bool
- property openapi_types
- property parent_id
Gets the parent_id of this Organization.
ID of the parent organization
- Returns
The parent_id of this Organization.
- Return type
string_types
- property signup_source
Gets the signup_source of this Organization.
which platform initiated organisation creation
- Returns
The signup_source of this Organization.
- Return type
- property type
Gets the type of this Organization.
Specifies the type of the organization in the hierachy. Only sub-organizations can be newly created. (required)
- Returns
The type of this Organization.
- Return type
bitmovin_api_sdk.models.organization_pending_invitation module
- class bitmovin_api_sdk.models.organization_pending_invitation.OrganizationPendingInvitation(**kwargs)[source]
Bases:
object- property attribute_map
- property email
Gets the email of this OrganizationPendingInvitation.
Email of Tenant (required)
- Returns
The email of this OrganizationPendingInvitation.
- Return type
string_types
- property group_id
Gets the group_id of this OrganizationPendingInvitation.
Id of group (required)
- Returns
The group_id of this OrganizationPendingInvitation.
- Return type
string_types
- property group_name
Gets the group_name of this OrganizationPendingInvitation.
Name of group (required)
- Returns
The group_name of this OrganizationPendingInvitation.
- Return type
string_types
- property id
Gets the id of this OrganizationPendingInvitation.
Id of Tenant (required)
- Returns
The id of this OrganizationPendingInvitation.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.organization_type module
bitmovin_api_sdk.models.ott_loudness_mode module
bitmovin_api_sdk.models.output module
- class bitmovin_api_sdk.models.output.Output(**kwargs)[source]
Bases:
BitmovinResource- property acl
Gets the acl of this Output.
Deprecation notice: This property does not have any effect and will not be returned by GET endpoints
- Returns
The acl of this Output.
- Return type
list[AclEntry]
- property attribute_map
- discriminator_value_class_map = {'AKAMAI_MSL': 'AkamaiMslOutput', 'AKAMAI_NETSTORAGE': 'AkamaiNetStorageOutput', 'AZURE': 'AzureOutput', 'CDN': 'CdnOutput', 'FTP': 'FtpOutput', 'GCS': 'GcsOutput', 'GCS_SERVICE_ACCOUNT': 'GcsServiceAccountOutput', 'GENERIC_S3': 'GenericS3Output', 'LIVE_MEDIA_INGEST': 'LiveMediaIngestOutput', 'LOCAL': 'LocalOutput', 'S3': 'S3Output', 'S3_ROLE_BASED': 'S3RoleBasedOutput', 'SFTP': 'SftpOutput'}
- property openapi_types
bitmovin_api_sdk.models.output_type module
- class bitmovin_api_sdk.models.output_type.OutputType(value)[source]
Bases:
EnumAn enumeration.
- AKAMAI_MSL = 'AKAMAI_MSL'
- AKAMAI_NETSTORAGE = 'AKAMAI_NETSTORAGE'
- AZURE = 'AZURE'
- CDN = 'CDN'
- FTP = 'FTP'
- GCS = 'GCS'
- GCS_SERVICE_ACCOUNT = 'GCS_SERVICE_ACCOUNT'
- GENERIC_S3 = 'GENERIC_S3'
- LIVE_MEDIA_INGEST = 'LIVE_MEDIA_INGEST'
- LOCAL = 'LOCAL'
- S3 = 'S3'
- S3_ROLE_BASED = 'S3_ROLE_BASED'
- SFTP = 'SFTP'
bitmovin_api_sdk.models.output_type_response module
bitmovin_api_sdk.models.packed_audio_muxing module
- class bitmovin_api_sdk.models.packed_audio_muxing.PackedAudioMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property openapi_types
- property segment_length
Gets the segment_length of this PackedAudioMuxing.
Duration of a segment, given in seconds (required)
- Returns
The segment_length of this PackedAudioMuxing.
- Return type
float
- property segment_naming
Gets the segment_naming of this PackedAudioMuxing.
Segment naming policy. The required filename extension depends on the codec (e.g. ‘.aac’ for AAC). Either this or segmentNamingTemplate must be set.
- Returns
The segment_naming of this PackedAudioMuxing.
- Return type
string_types
- property segment_naming_template
Gets the segment_naming_template of this PackedAudioMuxing.
Segment naming policy containing one or both of the following placeholders: - ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - ‘{segment_rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set. The required filename extension depends on the codec (e.g. ‘.aac’ for AAC).
- Returns
The segment_naming_template of this PackedAudioMuxing.
- Return type
string_types
- property segments_muxed
Gets the segments_muxed of this PackedAudioMuxing.
Number of segments which have been encoded
- Returns
The segments_muxed of this PackedAudioMuxing.
- Return type
int
- property start_offset
Gets the start_offset of this PackedAudioMuxing.
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).
- Returns
The start_offset of this PackedAudioMuxing.
- Return type
int
bitmovin_api_sdk.models.packed_audio_muxing_information module
bitmovin_api_sdk.models.padding_duration_unit module
bitmovin_api_sdk.models.padding_sequence module
- class bitmovin_api_sdk.models.padding_sequence.PaddingSequence(**kwargs)[source]
Bases:
object- property attribute_map
- property duration
Gets the duration of this PaddingSequence.
Duration of the padding sequence, given in the unit specified by the unit property. The maximum duration is 300 frames or 10 seconds. If the unit is FRAMES, this needs to be an integer value and will be interpreted based on the input frame rate of the main part of the ConcatenationInputStream that is used by your video output stream(s). FRAMES is not allowed if the encoding does not contain a video output stream. (required)
- Returns
The duration of this PaddingSequence.
- Return type
float
- property openapi_types
- property unit
Gets the unit of this PaddingSequence.
The unit of the duration property
- Returns
The unit of this PaddingSequence.
- Return type
bitmovin_api_sdk.models.pagination_response module
- class bitmovin_api_sdk.models.pagination_response.PaginationResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property items
Gets the items of this PaginationResponse.
- Returns
The items of this PaginationResponse.
- Return type
list[object]
- property limit
Gets the limit of this PaginationResponse.
- Returns
The limit of this PaginationResponse.
- Return type
int
- property next
Gets the next of this PaginationResponse.
- Returns
The next of this PaginationResponse.
- Return type
string_types
- property offset
Gets the offset of this PaginationResponse.
- Returns
The offset of this PaginationResponse.
- Return type
int
- property openapi_types
- property previous
Gets the previous of this PaginationResponse.
- Returns
The previous of this PaginationResponse.
- Return type
string_types
- property total_count
Gets the total_count of this PaginationResponse.
- Returns
The total_count of this PaginationResponse.
- Return type
int
bitmovin_api_sdk.models.passthrough_audio_configuration module
bitmovin_api_sdk.models.passthrough_mode module
bitmovin_api_sdk.models.pcm_audio_configuration module
- class bitmovin_api_sdk.models.pcm_audio_configuration.PcmAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this PcmAudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this PcmAudioConfiguration.
- Return type
- property openapi_types
- property preset_configuration
Gets the preset_configuration of this PcmAudioConfiguration.
Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.
- Returns
The preset_configuration of this PcmAudioConfiguration.
- Return type
- property sample_format
Gets the sample_format of this PcmAudioConfiguration.
Sampling format of the audio codec configuration
- Returns
The sample_format of this PcmAudioConfiguration.
- Return type
bitmovin_api_sdk.models.pcm_channel_layout module
bitmovin_api_sdk.models.pcm_preset_configuration module
bitmovin_api_sdk.models.pcm_sample_format module
bitmovin_api_sdk.models.per_title module
- class bitmovin_api_sdk.models.per_title.PerTitle(**kwargs)[source]
Bases:
object- property attribute_map
- property av1_configuration
Gets the av1_configuration of this PerTitle.
Per-Title configuration for AV1
- Returns
The av1_configuration of this PerTitle.
- Return type
- property h264_configuration
Gets the h264_configuration of this PerTitle.
Per-Title configuration for H264
- Returns
The h264_configuration of this PerTitle.
- Return type
- property h265_configuration
Gets the h265_configuration of this PerTitle.
Per-Title configuration for H265
- Returns
The h265_configuration of this PerTitle.
- Return type
- property openapi_types
- property vp9_configuration
Gets the vp9_configuration of this PerTitle.
Per-Title configuration for VP9
- Returns
The vp9_configuration of this PerTitle.
- Return type
bitmovin_api_sdk.models.per_title_configuration module
- class bitmovin_api_sdk.models.per_title_configuration.PerTitleConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property auto_representations
Gets the auto_representations of this PerTitleConfiguration.
- Returns
The auto_representations of this PerTitleConfiguration.
- Return type
- property complexity_factor
Gets the complexity_factor of this PerTitleConfiguration.
Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition
- Returns
The complexity_factor of this PerTitleConfiguration.
- Return type
float
- property fixed_resolution_and_bitrate_configuration
Gets the fixed_resolution_and_bitrate_configuration of this PerTitleConfiguration.
Additional configuration for fixed resolution and bitrate templates
- Returns
The fixed_resolution_and_bitrate_configuration of this PerTitleConfiguration.
- Return type
- property max_bitrate
Gets the max_bitrate of this PerTitleConfiguration.
The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.
- Returns
The max_bitrate of this PerTitleConfiguration.
- Return type
int
- property max_bitrate_step_size
Gets the max_bitrate_step_size of this PerTitleConfiguration.
The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.5 will require the next higher bitrate to be at most 360,000
- Returns
The max_bitrate_step_size of this PerTitleConfiguration.
- Return type
float
- property min_bitrate
Gets the min_bitrate of this PerTitleConfiguration.
The minimum bitrate that will be used by the Per-Title algorithm.
- Returns
The min_bitrate of this PerTitleConfiguration.
- Return type
int
- property min_bitrate_step_size
Gets the min_bitrate_step_size of this PerTitleConfiguration.
The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000
- Returns
The min_bitrate_step_size of this PerTitleConfiguration.
- Return type
float
- property openapi_types
- property resolution_scale_factor
Gets the resolution_scale_factor of this PerTitleConfiguration.
This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.
- Returns
The resolution_scale_factor of this PerTitleConfiguration.
- Return type
float
- property target_quality_crf
Gets the target_quality_crf of this PerTitleConfiguration.
Desired target quality of the highest representation expressed as CRF value
- Returns
The target_quality_crf of this PerTitleConfiguration.
- Return type
float
bitmovin_api_sdk.models.per_title_fixed_resolution_and_bitrate_configuration module
- class bitmovin_api_sdk.models.per_title_fixed_resolution_and_bitrate_configuration.PerTitleFixedResolutionAndBitrateConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property forced_rendition_above_highest_fixed_representation
Gets the forced_rendition_above_highest_fixed_representation of this PerTitleFixedResolutionAndBitrateConfiguration.
Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.
- Returns
The forced_rendition_above_highest_fixed_representation of this PerTitleFixedResolutionAndBitrateConfiguration.
- Return type
int
- property forced_rendition_above_highest_fixed_representation_calculation_mode
Gets the forced_rendition_above_highest_fixed_representation_calculation_mode of this PerTitleFixedResolutionAndBitrateConfiguration.
Mode to calculate the bitrate of the next representation
- Returns
The forced_rendition_above_highest_fixed_representation_calculation_mode of this PerTitleFixedResolutionAndBitrateConfiguration.
- Return type
- property forced_rendition_above_highest_fixed_representation_factor
Gets the forced_rendition_above_highest_fixed_representation_factor of this PerTitleFixedResolutionAndBitrateConfiguration.
The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.
- Returns
The forced_rendition_above_highest_fixed_representation_factor of this PerTitleFixedResolutionAndBitrateConfiguration.
- Return type
float
- property openapi_types
bitmovin_api_sdk.models.per_title_fixed_resolution_and_bitrate_configuration_mode module
bitmovin_api_sdk.models.period module
- class bitmovin_api_sdk.models.period.Period(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property duration
Gets the duration of this Period.
Duration in seconds.<br/>Please note that the duration of a Period is usually determined by the media contained therein.<br/>Setting the duration property to a specific value will override this default behaviour.<br/>Warning: Use at your own risk!
- Returns
The duration of this Period.
- Return type
float
- property openapi_types
- property start
Gets the start of this Period.
Starting time in seconds
- Returns
The start of this Period.
- Return type
float
bitmovin_api_sdk.models.permission module
bitmovin_api_sdk.models.picture_field_parity module
bitmovin_api_sdk.models.pixel_format module
- class bitmovin_api_sdk.models.pixel_format.PixelFormat(value)[source]
Bases:
EnumAn enumeration.
- YUV410P = 'YUV410P'
- YUV411P = 'YUV411P'
- YUV420P = 'YUV420P'
- YUV420P10BE = 'YUV420P10BE'
- YUV420P10LE = 'YUV420P10LE'
- YUV420P12BE = 'YUV420P12BE'
- YUV420P12LE = 'YUV420P12LE'
- YUV422P = 'YUV422P'
- YUV422P10BE = 'YUV422P10BE'
- YUV422P10LE = 'YUV422P10LE'
- YUV422P12BE = 'YUV422P12BE'
- YUV422P12LE = 'YUV422P12LE'
- YUV440P = 'YUV440P'
- YUV440P10BE = 'YUV440P10BE'
- YUV440P10LE = 'YUV440P10LE'
- YUV440P12BE = 'YUV440P12BE'
- YUV440P12LE = 'YUV440P12LE'
- YUV444P = 'YUV444P'
- YUV444P10BE = 'YUV444P10BE'
- YUV444P10LE = 'YUV444P10LE'
- YUV444P12BE = 'YUV444P12BE'
- YUV444P12LE = 'YUV444P12LE'
- YUVJ411P = 'YUVJ411P'
- YUVJ420P = 'YUVJ420P'
- YUVJ422P = 'YUVJ422P'
- YUVJ440P = 'YUVJ440P'
- YUVJ444P = 'YUVJ444P'
bitmovin_api_sdk.models.pixel_format_bit_depth module
bitmovin_api_sdk.models.plaintext_id3_tag module
- class bitmovin_api_sdk.models.plaintext_id3_tag.PlaintextId3Tag(**kwargs)[source]
Bases:
Id3Tag- property attribute_map
- property frame_id
Gets the frame_id of this PlaintextId3Tag.
4 character long Frame ID (required)
- Returns
The frame_id of this PlaintextId3Tag.
- Return type
string_types
- property openapi_types
- property text
Gets the text of this PlaintextId3Tag.
Plain Text Data (required)
- Returns
The text of this PlaintextId3Tag.
- Return type
string_types
bitmovin_api_sdk.models.play_ready_additional_information module
- class bitmovin_api_sdk.models.play_ready_additional_information.PlayReadyAdditionalInformation(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property wrm_header_custom_attributes
Gets the wrm_header_custom_attributes of this PlayReadyAdditionalInformation.
Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.
- Returns
The wrm_header_custom_attributes of this PlayReadyAdditionalInformation.
- Return type
string_types
bitmovin_api_sdk.models.play_ready_drm module
- class bitmovin_api_sdk.models.play_ready_drm.PlayReadyDrm(**kwargs)[source]
Bases:
Drm- property additional_information
Gets the additional_information of this PlayReadyDrm.
- Returns
The additional_information of this PlayReadyDrm.
- Return type
- property attribute_map
- property key
Gets the key of this PlayReadyDrm.
16 byte encryption key, 32 hexadecimal characters. Either key or keySeed is required
- Returns
The key of this PlayReadyDrm.
- Return type
string_types
- property key_seed
Gets the key_seed of this PlayReadyDrm.
Key seed to generate key. Either key or keySeed is required
- Returns
The key_seed of this PlayReadyDrm.
- Return type
string_types
- property kid
Gets the kid of this PlayReadyDrm.
Key identifier
- Returns
The kid of this PlayReadyDrm.
- Return type
string_types
- property la_url
Gets the la_url of this PlayReadyDrm.
URL of the license server
- Returns
The la_url of this PlayReadyDrm.
- Return type
string_types
- property method
Gets the method of this PlayReadyDrm.
- Returns
The method of this PlayReadyDrm.
- Return type
- property openapi_types
- property pssh
Gets the pssh of this PlayReadyDrm.
Base64 encoded pssh payload
- Returns
The pssh of this PlayReadyDrm.
- Return type
string_types
bitmovin_api_sdk.models.play_ready_encryption_method module
bitmovin_api_sdk.models.player_channel module
bitmovin_api_sdk.models.player_license module
- class bitmovin_api_sdk.models.player_license.PlayerLicense(**kwargs)[source]
Bases:
BitmovinResponse- property analytics_key
Gets the analytics_key of this PlayerLicense.
Analytics License Key
- Returns
The analytics_key of this PlayerLicense.
- Return type
string_types
- property attribute_map
- property created_at
Gets the created_at of this PlayerLicense.
Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)
- Returns
The created_at of this PlayerLicense.
- Return type
datetime
- property domains
Gets the domains of this PlayerLicense.
Whitelisted domains (required)
- Returns
The domains of this PlayerLicense.
- Return type
list[Domain]
- property impressions
Gets the impressions of this PlayerLicense.
Number of impressions recorded (required)
- Returns
The impressions of this PlayerLicense.
- Return type
int
- property license_key
Gets the license_key of this PlayerLicense.
License Key (required)
- Returns
The license_key of this PlayerLicense.
- Return type
string_types
- property max_impressions
Gets the max_impressions of this PlayerLicense.
Maximum number of impressions (required)
- Returns
The max_impressions of this PlayerLicense.
- Return type
int
- property name
Gets the name of this PlayerLicense.
Name of the resource (required)
- Returns
The name of this PlayerLicense.
- Return type
string_types
- property openapi_types
- property third_party_licensing_enabled
Gets the third_party_licensing_enabled of this PlayerLicense.
Flag if third party licensing is enabled (required)
- Returns
The third_party_licensing_enabled of this PlayerLicense.
- Return type
bool
bitmovin_api_sdk.models.player_license_analytics module
- class bitmovin_api_sdk.models.player_license_analytics.PlayerLicenseAnalytics(**kwargs)[source]
Bases:
object- property analytics_key
Gets the analytics_key of this PlayerLicenseAnalytics.
Analytics License Key (required)
- Returns
The analytics_key of this PlayerLicenseAnalytics.
- Return type
string_types
- property attribute_map
- property openapi_types
bitmovin_api_sdk.models.player_third_party_licensing module
- class bitmovin_api_sdk.models.player_third_party_licensing.PlayerThirdPartyLicensing(**kwargs)[source]
Bases:
object- property attribute_map
- property error_action
Gets the error_action of this PlayerThirdPartyLicensing.
Specify if the Licensing Request should fail or not on Third Party Licensing Error (required)
- Returns
The error_action of this PlayerThirdPartyLicensing.
- Return type
- property license_check_server
Gets the license_check_server of this PlayerThirdPartyLicensing.
URL to your license check server (required)
- Returns
The license_check_server of this PlayerThirdPartyLicensing.
- Return type
string_types
- property license_check_timeout
Gets the license_check_timeout of this PlayerThirdPartyLicensing.
Timeout in ms (required)
- Returns
The license_check_timeout of this PlayerThirdPartyLicensing.
- Return type
int
- property openapi_types
- property timeout_action
Gets the timeout_action of this PlayerThirdPartyLicensing.
Specify if the Licensing Request should fail or not on Third Party Licensing timeout (required)
- Returns
The timeout_action of this PlayerThirdPartyLicensing.
- Return type
bitmovin_api_sdk.models.player_third_party_licensing_error_action module
bitmovin_api_sdk.models.player_version module
- class bitmovin_api_sdk.models.player_version.PlayerVersion(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property cdn_url
Gets the cdn_url of this PlayerVersion.
URL of the specified player (required)
- Returns
The cdn_url of this PlayerVersion.
- Return type
string_types
- property created_at
Gets the created_at of this PlayerVersion.
Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)
- Returns
The created_at of this PlayerVersion.
- Return type
datetime
- property download_url
Gets the download_url of this PlayerVersion.
Download URL of the specified player package (required)
- Returns
The download_url of this PlayerVersion.
- Return type
string_types
- property openapi_types
- property version
Gets the version of this PlayerVersion.
Version of the Player (required)
- Returns
The version of this PlayerVersion.
- Return type
string_types
bitmovin_api_sdk.models.policy module
bitmovin_api_sdk.models.position_mode module
bitmovin_api_sdk.models.position_unit module
bitmovin_api_sdk.models.preset_configuration module
- class bitmovin_api_sdk.models.preset_configuration.PresetConfiguration(value)[source]
Bases:
EnumAn enumeration.
- LIVE_HIGH_QUALITY = 'LIVE_HIGH_QUALITY'
- LIVE_LOWER_LATENCY = 'LIVE_LOWER_LATENCY'
- LIVE_LOW_LATENCY = 'LIVE_LOW_LATENCY'
- LIVE_STANDARD = 'LIVE_STANDARD'
- LIVE_ULTRAHIGH_QUALITY = 'LIVE_ULTRAHIGH_QUALITY'
- LIVE_VERYHIGH_QUALITY = 'LIVE_VERYHIGH_QUALITY'
- LIVE_VERYLOW_LATENCY = 'LIVE_VERYLOW_LATENCY'
- VOD_EXTRAHIGH_SPEED = 'VOD_EXTRAHIGH_SPEED'
- VOD_HARDWARE_SHORTFORM = 'VOD_HARDWARE_SHORTFORM'
- VOD_HIGH_QUALITY = 'VOD_HIGH_QUALITY'
- VOD_HIGH_SPEED = 'VOD_HIGH_SPEED'
- VOD_QUALITY = 'VOD_QUALITY'
- VOD_SPEED = 'VOD_SPEED'
- VOD_STANDARD = 'VOD_STANDARD'
- VOD_SUPERHIGH_SPEED = 'VOD_SUPERHIGH_SPEED'
- VOD_ULTRAHIGH_SPEED = 'VOD_ULTRAHIGH_SPEED'
- VOD_VERYHIGH_SPEED = 'VOD_VERYHIGH_SPEED'
bitmovin_api_sdk.models.prewarmed_encoder_disk_size module
bitmovin_api_sdk.models.prewarmed_encoder_pool module
- class bitmovin_api_sdk.models.prewarmed_encoder_pool.PrewarmedEncoderPool(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property cloud_region
Gets the cloud_region of this PrewarmedEncoderPool.
The cloud region in which the pool’s instances will be running. Must be a specific region (e.g. not ‘AUTO’, ‘GOOGLE’ or ‘EUROPE’) (required)
- Returns
The cloud_region of this PrewarmedEncoderPool.
- Return type
- property disk_size
Gets the disk_size of this PrewarmedEncoderPool.
Disk size of the prewarmed instances in GB. Needs to be chosen depending on input file sizes and encoding features used. (required)
- Returns
The disk_size of this PrewarmedEncoderPool.
- Return type
- property dynamic_pool
Gets the dynamic_pool of this PrewarmedEncoderPool.
Activate dynamic pool behaviour. Pool will increase/decrease based on usage up until a size of 10 instances. Minimum pool size is set by targetPoolSize
- Returns
The dynamic_pool of this PrewarmedEncoderPool.
- Return type
bool
- property encoder_version
Gets the encoder_version of this PrewarmedEncoderPool.
The encoder version which the pool’s instances will be running (required)
- Returns
The encoder_version of this PrewarmedEncoderPool.
- Return type
string_types
- property gpu_enabled
Gets the gpu_enabled of this PrewarmedEncoderPool.
Create pool with GPU instances for hardware encoding presets (e.g., VOD_HARDWARE_SHORTFORM).
- Returns
The gpu_enabled of this PrewarmedEncoderPool.
- Return type
bool
- property infrastructure_id
Gets the infrastructure_id of this PrewarmedEncoderPool.
Define an external infrastructure to run the pool on.
- Returns
The infrastructure_id of this PrewarmedEncoderPool.
- Return type
string_types
- property openapi_types
- property status
Gets the status of this PrewarmedEncoderPool.
Current status of the pool.
- Returns
The status of this PrewarmedEncoderPool.
- Return type
- property target_pool_size
Gets the target_pool_size of this PrewarmedEncoderPool.
Number of instances to keep prewarmed while the pool is running (required)
- Returns
The target_pool_size of this PrewarmedEncoderPool.
- Return type
int
bitmovin_api_sdk.models.prewarmed_encoder_pool_action module
bitmovin_api_sdk.models.prewarmed_encoder_pool_schedule module
- class bitmovin_api_sdk.models.prewarmed_encoder_pool_schedule.PrewarmedEncoderPoolSchedule(**kwargs)[source]
Bases:
BitmovinResponse- property action
Gets the action of this PrewarmedEncoderPoolSchedule.
The action to be triggered by the schedule (start or stop) (required)
- Returns
The action of this PrewarmedEncoderPoolSchedule.
- Return type
- property attribute_map
- property openapi_types
- property trigger_date
Gets the trigger_date of this PrewarmedEncoderPoolSchedule.
An instant in the future when the specified action should be triggered. Given as UTC expressed in ISO 8601 format (“YYYY-MM-DDThh:mm:ssZ”). Seconds will be ignored. (required)
- Returns
The trigger_date of this PrewarmedEncoderPoolSchedule.
- Return type
datetime
bitmovin_api_sdk.models.prewarmed_encoder_pool_status module
bitmovin_api_sdk.models.prime_time_drm module
- class bitmovin_api_sdk.models.prime_time_drm.PrimeTimeDrm(**kwargs)[source]
Bases:
Drm- property attribute_map
- property key
Gets the key of this PrimeTimeDrm.
16 byte Encryption key, 32 hexadecimal characters (required)
- Returns
The key of this PrimeTimeDrm.
- Return type
string_types
- property kid
Gets the kid of this PrimeTimeDrm.
16 byte Key id, 32 hexadecimal characters (required)
- Returns
The kid of this PrimeTimeDrm.
- Return type
string_types
- property openapi_types
- property pssh
Gets the pssh of this PrimeTimeDrm.
Base 64 Encoded (required)
- Returns
The pssh of this PrimeTimeDrm.
- Return type
string_types
bitmovin_api_sdk.models.profile_h262 module
bitmovin_api_sdk.models.profile_h264 module
bitmovin_api_sdk.models.profile_h265 module
bitmovin_api_sdk.models.program_date_time_settings module
- class bitmovin_api_sdk.models.program_date_time_settings.ProgramDateTimeSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property program_date_time_source
Gets the program_date_time_source of this ProgramDateTimeSettings.
- Returns
The program_date_time_source of this ProgramDateTimeSettings.
- Return type
bitmovin_api_sdk.models.program_date_time_source module
bitmovin_api_sdk.models.progressive_mov_muxing module
- class bitmovin_api_sdk.models.progressive_mov_muxing.ProgressiveMovMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property filename
Gets the filename of this ProgressiveMovMuxing.
Name of the output file
- Returns
The filename of this ProgressiveMovMuxing.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.progressive_mov_muxing_information module
bitmovin_api_sdk.models.progressive_muxing_information module
- class bitmovin_api_sdk.models.progressive_muxing_information.ProgressiveMuxingInformation(**kwargs)[source]
Bases:
object- property attribute_map
- property audio_tracks
Gets the audio_tracks of this ProgressiveMuxingInformation.
Information about the audio tracks in the container
- Returns
The audio_tracks of this ProgressiveMuxingInformation.
- Return type
- property container_bitrate
Gets the container_bitrate of this ProgressiveMuxingInformation.
The bitrate of the container if available (tracks + container overhead)
- Returns
The container_bitrate of this ProgressiveMuxingInformation.
- Return type
int
- property container_format
Gets the container_format of this ProgressiveMuxingInformation.
The container format used
- Returns
The container_format of this ProgressiveMuxingInformation.
- Return type
string_types
- property duration
Gets the duration of this ProgressiveMuxingInformation.
The duration of the container in seconds
- Returns
The duration of this ProgressiveMuxingInformation.
- Return type
float
- property file_size
Gets the file_size of this ProgressiveMuxingInformation.
The file size of the muxing in bytes
- Returns
The file_size of this ProgressiveMuxingInformation.
- Return type
int
- property mime_type
Gets the mime_type of this ProgressiveMuxingInformation.
The mime type of the muxing
- Returns
The mime_type of this ProgressiveMuxingInformation.
- Return type
string_types
- property openapi_types
- property video_tracks
Gets the video_tracks of this ProgressiveMuxingInformation.
Information about the video tracks in the container
- Returns
The video_tracks of this ProgressiveMuxingInformation.
- Return type
bitmovin_api_sdk.models.progressive_ts_muxing module
- class bitmovin_api_sdk.models.progressive_ts_muxing.ProgressiveTsMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property filename
Gets the filename of this ProgressiveTsMuxing.
Name of the output file
- Returns
The filename of this ProgressiveTsMuxing.
- Return type
string_types
- property openapi_types
- property segment_length
Gets the segment_length of this ProgressiveTsMuxing.
Length of the segments in seconds
- Returns
The segment_length of this ProgressiveTsMuxing.
- Return type
float
- property start_offset
Gets the start_offset of this ProgressiveTsMuxing.
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).
- Returns
The start_offset of this ProgressiveTsMuxing.
- Return type
int
bitmovin_api_sdk.models.progressive_ts_muxing_information module
- class bitmovin_api_sdk.models.progressive_ts_muxing_information.ProgressiveTsMuxingInformation(**kwargs)[source]
Bases:
ProgressiveMuxingInformation- property attribute_map
- property byte_ranges
Gets the byte_ranges of this ProgressiveTsMuxingInformation.
Byte ranges for the segments within the TS file
- Returns
The byte_ranges of this ProgressiveTsMuxingInformation.
- Return type
- property openapi_types
bitmovin_api_sdk.models.progressive_ts_muxing_information_byte_ranges module
- class bitmovin_api_sdk.models.progressive_ts_muxing_information_byte_ranges.ProgressiveTsMuxingInformationByteRanges(**kwargs)[source]
Bases:
object- property attribute_map
- property duration
Gets the duration of this ProgressiveTsMuxingInformationByteRanges.
The duration of the segment in seconds
- Returns
The duration of this ProgressiveTsMuxingInformationByteRanges.
- Return type
float
- property end_bytes
Gets the end_bytes of this ProgressiveTsMuxingInformationByteRanges.
The position of the last byte of the segment
- Returns
The end_bytes of this ProgressiveTsMuxingInformationByteRanges.
- Return type
int
- property openapi_types
- property segment_number
Gets the segment_number of this ProgressiveTsMuxingInformationByteRanges.
Number of the segment (starting at 0) (required)
- Returns
The segment_number of this ProgressiveTsMuxingInformationByteRanges.
- Return type
int
- property start_bytes
Gets the start_bytes of this ProgressiveTsMuxingInformationByteRanges.
The position of the first byte of the segment
- Returns
The start_bytes of this ProgressiveTsMuxingInformationByteRanges.
- Return type
int
bitmovin_api_sdk.models.progressive_wav_muxing module
- class bitmovin_api_sdk.models.progressive_wav_muxing.ProgressiveWavMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property filename
Gets the filename of this ProgressiveWavMuxing.
Name of the output file (required)
- Returns
The filename of this ProgressiveWavMuxing.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.progressive_wav_muxing_information module
bitmovin_api_sdk.models.progressive_webm_muxing module
- class bitmovin_api_sdk.models.progressive_webm_muxing.ProgressiveWebmMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property filename
Gets the filename of this ProgressiveWebmMuxing.
Name of the output file
- Returns
The filename of this ProgressiveWebmMuxing.
- Return type
string_types
- property manifest_type
Gets the manifest_type of this ProgressiveWebmMuxing.
- Returns
The manifest_type of this ProgressiveWebmMuxing.
- Return type
- property openapi_types
- property segment_length
Gets the segment_length of this ProgressiveWebmMuxing.
Determines the length of segments in seconds if manifestType is set to DASH_ON_DEMAND. Defaults to 4 seconds
- Returns
The segment_length of this ProgressiveWebmMuxing.
- Return type
float
bitmovin_api_sdk.models.progressive_webm_muxing_information module
bitmovin_api_sdk.models.progressive_webm_muxing_manifest_type module
bitmovin_api_sdk.models.psnr_per_stream_mode module
bitmovin_api_sdk.models.psnr_quality_metric module
- class bitmovin_api_sdk.models.psnr_quality_metric.PsnrQualityMetric(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property psnr
Gets the psnr of this PsnrQualityMetric.
Peak signal-to-noise ratio (required)
- Returns
The psnr of this PsnrQualityMetric.
- Return type
float
- property time_span
Gets the time_span of this PsnrQualityMetric.
- Returns
The time_span of this PsnrQualityMetric.
- Return type
bitmovin_api_sdk.models.pts_align_mode module
bitmovin_api_sdk.models.quantization_group_size module
bitmovin_api_sdk.models.rai_unit module
bitmovin_api_sdk.models.rate_distortion_level_for_quantization module
bitmovin_api_sdk.models.rate_distortion_penalty_mode module
bitmovin_api_sdk.models.raw_id3_tag module
bitmovin_api_sdk.models.redundant_rtmp_input module
- class bitmovin_api_sdk.models.redundant_rtmp_input.RedundantRtmpInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property delay_threshold
Gets the delay_threshold of this RedundantRtmpInput.
When there is no input signal present and this threshold in seconds is reached it will switch to another ingest point
- Returns
The delay_threshold of this RedundantRtmpInput.
- Return type
int
- property ingest_points
Gets the ingest_points of this RedundantRtmpInput.
Configuration for ingest points that use a dynamic IP based endpoint to stream to e.g.: rtmp://41.167.11.21/live Either ingestPoints or staticIngestPoints can be set
- Returns
The ingest_points of this RedundantRtmpInput.
- Return type
list[RtmpIngestPoint]
- property openapi_types
- property static_ingest_points
Gets the static_ingest_points of this RedundantRtmpInput.
Configuration for static ingest points. These ingest points use a consistent endpoint to stream to e.g.: rtmps://live-ingest.bitmovin.com/live Either ingestPoints or staticIngestPoints can be set
- Returns
The static_ingest_points of this RedundantRtmpInput.
- Return type
list[StaticRtmpIngestPoint]
bitmovin_api_sdk.models.reprioritize_encoding_request module
- class bitmovin_api_sdk.models.reprioritize_encoding_request.ReprioritizeEncodingRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property priority
Gets the priority of this ReprioritizeEncodingRequest.
Priority of the Encoding (required)
- Returns
The priority of this ReprioritizeEncodingRequest.
- Return type
int
bitmovin_api_sdk.models.reschedule_encoding_request module
- class bitmovin_api_sdk.models.reschedule_encoding_request.RescheduleEncodingRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property infrastructure_id
Gets the infrastructure_id of this RescheduleEncodingRequest.
Id of a custom infrastructure, e.g., AWS Cloud Connect
- Returns
The infrastructure_id of this RescheduleEncodingRequest.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.reset_live_manifest_time_shift module
- class bitmovin_api_sdk.models.reset_live_manifest_time_shift.ResetLiveManifestTimeShift(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property manifest_ids
Gets the manifest_ids of this ResetLiveManifestTimeShift.
The ids of the manifests to update. If this property is not set, all manifests tied to the encoding are updated.
- Returns
The manifest_ids of this ResetLiveManifestTimeShift.
- Return type
list[string_types]
- property offset_in_seconds
Gets the offset_in_seconds of this ResetLiveManifestTimeShift.
Offset in seconds from the start of the live event, defining the point from which all segments within that duration will be removed from the given manifests. E.g.: The segment length is 2 seconds and a timeshift of 120 seconds (2 minutes) is configured. The manifest contains 60 segments with the last segment number being 80 (segment_80.ts). This means the manifest contains segment_20.ts to segment_80.ts (timeshift of 2 minutes equals 60 segments in manifest) If you set offsetInSeconds to 120, all segments below segment number 60 (segment_60.ts) will be removed. (targetSegmentNumber = offsetInSeconds / segmentLength) The manifests will then contain segment_60.ts to segment_80.ts Note: Only offsetInSeconds or residualPeriodInSeconds can be set.
- Returns
The offset_in_seconds of this ResetLiveManifestTimeShift.
- Return type
float
- property openapi_types
- property residual_period_in_seconds
Gets the residual_period_in_seconds of this ResetLiveManifestTimeShift.
Determines how many seconds will be left in the manifest after segments are removed. If this is not set, all but one segment will be removed.
- Returns
The residual_period_in_seconds of this ResetLiveManifestTimeShift.
- Return type
float
- property shift_progressive_muxing_start_position
Gets the shift_progressive_muxing_start_position of this ResetLiveManifestTimeShift.
If set to true, the Progressive muxing start position will be shifted to the start of the first remaining segment after the removal. NOTE: This only works for Progressive MP4 muxings.
- Returns
The shift_progressive_muxing_start_position of this ResetLiveManifestTimeShift.
- Return type
bool
bitmovin_api_sdk.models.resource_limit module
- class bitmovin_api_sdk.models.resource_limit.ResourceLimit(**kwargs)[source]
Bases:
object- property attribute_map
- property effective_value
Gets the effective_value of this ResourceLimit.
Specifies the remaining limit value for limits divided to sub-organizations. This property is returned only for parent organizations and only for mentioned limits.
- Returns
The effective_value of this ResourceLimit.
- Return type
string_types
- property name
Gets the name of this ResourceLimit.
- Returns
The name of this ResourceLimit.
- Return type
string_types
- property openapi_types
- property value
Gets the value of this ResourceLimit.
- Returns
The value of this ResourceLimit.
- Return type
string_types
bitmovin_api_sdk.models.resource_limit_container module
- class bitmovin_api_sdk.models.resource_limit_container.ResourceLimitContainer(**kwargs)[source]
Bases:
object- property attribute_map
- property limits
Gets the limits of this ResourceLimitContainer.
- Returns
The limits of this ResourceLimitContainer.
- Return type
list[ResourceLimit]
- property openapi_types
- property resource
Gets the resource of this ResourceLimitContainer.
- Returns
The resource of this ResourceLimitContainer.
- Return type
bitmovin_api_sdk.models.resource_type module
bitmovin_api_sdk.models.response_envelope module
- class bitmovin_api_sdk.models.response_envelope.ResponseEnvelope(**kwargs)[source]
Bases:
object- property attribute_map
- property data
Gets the data of this ResponseEnvelope.
Response information (required)
- Returns
The data of this ResponseEnvelope.
- Return type
- property more
Gets the more of this ResponseEnvelope.
Additional endpoint specific information
- Returns
The more of this ResponseEnvelope.
- Return type
object
- property openapi_types
- property request_id
Gets the request_id of this ResponseEnvelope.
Unique correlation id (required)
- Returns
The request_id of this ResponseEnvelope.
- Return type
string_types
- property status
Gets the status of this ResponseEnvelope.
Response status information (required)
- Returns
The status of this ResponseEnvelope.
- Return type
bitmovin_api_sdk.models.response_error module
- class bitmovin_api_sdk.models.response_error.ResponseError(**kwargs)[source]
Bases:
object- property attribute_map
- property data
Gets the data of this ResponseError.
Response information (required)
- Returns
The data of this ResponseError.
- Return type
- property openapi_types
- property request_id
Gets the request_id of this ResponseError.
Unique correlation id (required)
- Returns
The request_id of this ResponseError.
- Return type
string_types
- property status
Gets the status of this ResponseError.
Response status information (required)
- Returns
The status of this ResponseError.
- Return type
bitmovin_api_sdk.models.response_error_data module
- class bitmovin_api_sdk.models.response_error_data.ResponseErrorData(**kwargs)[source]
Bases:
object- property attribute_map
- property code
Gets the code of this ResponseErrorData.
Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes (required)
- Returns
The code of this ResponseErrorData.
- Return type
int
- property details
Gets the details of this ResponseErrorData.
collection of messages containing more detailed information on the cause of the error
- Returns
The details of this ResponseErrorData.
- Return type
list[Message]
- property developer_message
Gets the developer_message of this ResponseErrorData.
More detailed message meant for developers (required)
- Returns
The developer_message of this ResponseErrorData.
- Return type
string_types
- property links
Gets the links of this ResponseErrorData.
collection of links to webpages containing further information on the topic
- Returns
The links of this ResponseErrorData.
- Return type
list[Link]
- property message
Gets the message of this ResponseErrorData.
General error message (required)
- Returns
The message of this ResponseErrorData.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.response_status module
bitmovin_api_sdk.models.result_wrapper module
bitmovin_api_sdk.models.retry_hint module
bitmovin_api_sdk.models.reupload_settings module
- class bitmovin_api_sdk.models.reupload_settings.ReuploadSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property dash_manifest_interval
Gets the dash_manifest_interval of this ReuploadSettings.
Interval in seconds to reupload the DASH manifest. Valid values are either null to never reupload the dash manifest or at least 30.
- Returns
The dash_manifest_interval of this ReuploadSettings.
- Return type
float
- property hls_manifest_interval
Gets the hls_manifest_interval of this ReuploadSettings.
Interval in seconds to reupload the HLS master file. Valid values are either 0 to never reupload the hls manifest or at least 30. This is currently not used, as the master file will always be uploaded when one of the playlist files has changed.
- Returns
The hls_manifest_interval of this ReuploadSettings.
- Return type
float
- property muxing_init_file_interval
Gets the muxing_init_file_interval of this ReuploadSettings.
The interval in seconds to reupload the init file for segmented muxings, e.g. fMP4, WebM. Valid values are either null to never reupload the init file for segmented muxings or at least 30.
- Returns
The muxing_init_file_interval of this ReuploadSettings.
- Return type
float
- property openapi_types
bitmovin_api_sdk.models.rotate_filter module
- class bitmovin_api_sdk.models.rotate_filter.RotateFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property openapi_types
- property rotation
Gets the rotation of this RotateFilter.
Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise. (required)
- Returns
The rotation of this RotateFilter.
- Return type
int
bitmovin_api_sdk.models.rtmp_ingest_point module
- class bitmovin_api_sdk.models.rtmp_ingest_point.RtmpIngestPoint(**kwargs)[source]
Bases:
object- property application_name
Gets the application_name of this RtmpIngestPoint.
The name of the application where the ingest is streamed to. This has to be unique for each ingest point (required)
- Returns
The application_name of this RtmpIngestPoint.
- Return type
string_types
- property attribute_map
- property openapi_types
- property stream_key
Gets the stream_key of this RtmpIngestPoint.
The stream key for the backup input (required)
- Returns
The stream_key of this RtmpIngestPoint.
- Return type
string_types
bitmovin_api_sdk.models.rtmp_input module
bitmovin_api_sdk.models.s3_access_style module
bitmovin_api_sdk.models.s3_input module
- class bitmovin_api_sdk.models.s3_input.S3Input(**kwargs)[source]
Bases:
Input- property access_key
Gets the access_key of this S3Input.
Amazon access key (required)
- Returns
The access_key of this S3Input.
- Return type
string_types
- property attribute_map
- property bucket_name
Gets the bucket_name of this S3Input.
Name of the bucket (required)
- Returns
The bucket_name of this S3Input.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this S3Input.
The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.
- Returns
The cloud_region of this S3Input.
- Return type
- property openapi_types
- property secret_key
Gets the secret_key of this S3Input.
Amazon secret key (required)
- Returns
The secret_key of this S3Input.
- Return type
string_types
bitmovin_api_sdk.models.s3_output module
- class bitmovin_api_sdk.models.s3_output.S3Output(**kwargs)[source]
Bases:
Output- property access_key
Gets the access_key of this S3Output.
Amazon S3 access key (required)
- Returns
The access_key of this S3Output.
- Return type
string_types
- property attribute_map
- property bucket_name
Gets the bucket_name of this S3Output.
Amazon S3 bucket name (required)
- Returns
The bucket_name of this S3Output.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this S3Output.
The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.
- Returns
The cloud_region of this S3Output.
- Return type
- property md5_meta_tag
Gets the md5_meta_tag of this S3Output.
If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.
- Returns
The md5_meta_tag of this S3Output.
- Return type
string_types
- property openapi_types
- property secret_key
Gets the secret_key of this S3Output.
Amazon S3 secret key (required)
- Returns
The secret_key of this S3Output.
- Return type
string_types
- property signature_version
Gets the signature_version of this S3Output.
Specifies the method used for authentication. Must be set to S3_V2 if the region supports both V2 and V4, but the bucket allows V2 only (see https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
- Returns
The signature_version of this S3Output.
- Return type
bitmovin_api_sdk.models.s3_role_based_input module
- class bitmovin_api_sdk.models.s3_role_based_input.S3RoleBasedInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property bucket_name
Gets the bucket_name of this S3RoleBasedInput.
Amazon S3 bucket name (required)
- Returns
The bucket_name of this S3RoleBasedInput.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this S3RoleBasedInput.
- Returns
The cloud_region of this S3RoleBasedInput.
- Return type
- property external_id
Gets the external_id of this S3RoleBasedInput.
External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won’t be able to read from the S3 bucket. An appropriate trust policy would look like this:
` { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "{{externalId}}" } } } `where “{{externalId}}” is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the input configuration Bitmovin won’t be able to read from the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won’t be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new input, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html- Returns
The external_id of this S3RoleBasedInput.
- Return type
string_types
- property external_id_mode
Gets the external_id_mode of this S3RoleBasedInput.
- Returns
The external_id_mode of this S3RoleBasedInput.
- Return type
- property openapi_types
- property role_arn
Gets the role_arn of this S3RoleBasedInput.
Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role:
` { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "{{externalId}}" } } } `where “arn:aws:iam::630681592166:user/bitmovinCustomerS3Access” is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to read data from your S3 bucket. Please note that the IAM role has to have read access on S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)- Returns
The role_arn of this S3RoleBasedInput.
- Return type
string_types
bitmovin_api_sdk.models.s3_role_based_output module
- class bitmovin_api_sdk.models.s3_role_based_output.S3RoleBasedOutput(**kwargs)[source]
Bases:
Output- property attribute_map
- property bucket_name
Gets the bucket_name of this S3RoleBasedOutput.
Amazon S3 bucket name (required)
- Returns
The bucket_name of this S3RoleBasedOutput.
- Return type
string_types
- property cloud_region
Gets the cloud_region of this S3RoleBasedOutput.
- Returns
The cloud_region of this S3RoleBasedOutput.
- Return type
- property external_id
Gets the external_id of this S3RoleBasedOutput.
External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won’t be able to write to the S3 bucket. An appropriate trust policy would look like this:
` { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "{{externalId}}" } } } `where “{{externalId}}” is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the output configuration Bitmovin won’t be able to write to the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won’t be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new output, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html- Returns
The external_id of this S3RoleBasedOutput.
- Return type
string_types
- property external_id_mode
Gets the external_id_mode of this S3RoleBasedOutput.
- Returns
The external_id_mode of this S3RoleBasedOutput.
- Return type
- property md5_meta_tag
Gets the md5_meta_tag of this S3RoleBasedOutput.
If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.
- Returns
The md5_meta_tag of this S3RoleBasedOutput.
- Return type
string_types
- property openapi_types
- property role_arn
Gets the role_arn of this S3RoleBasedOutput.
Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role:
` { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "{{externalId}}" } } } `where “arn:aws:iam::630681592166:user/bitmovinCustomerS3Access” is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to write data to your S3 bucket. Please note that the IAM role has to have write access to S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)- Returns
The role_arn of this S3RoleBasedOutput.
- Return type
string_types
- property signature_version
Gets the signature_version of this S3RoleBasedOutput.
Specifies the method used for authentication
- Returns
The signature_version of this S3RoleBasedOutput.
- Return type
bitmovin_api_sdk.models.s3_signature_version module
bitmovin_api_sdk.models.scale_filter module
- class bitmovin_api_sdk.models.scale_filter.ScaleFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property height
Gets the height of this ScaleFilter.
The height of the output frame in pixels. If not set it will be based on the configured width by maintaining the original aspect ratio. If width is also not set, the original source dimensions will be applied.
- Returns
The height of this ScaleFilter.
- Return type
int
- property openapi_types
- property sample_aspect_ratio_denominator
Gets the sample_aspect_ratio_denominator of this ScaleFilter.
The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set.
- Returns
The sample_aspect_ratio_denominator of this ScaleFilter.
- Return type
int
- property sample_aspect_ratio_numerator
Gets the sample_aspect_ratio_numerator of this ScaleFilter.
The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set.
- Returns
The sample_aspect_ratio_numerator of this ScaleFilter.
- Return type
int
- property scaling_algorithm
Gets the scaling_algorithm of this ScaleFilter.
- Returns
The scaling_algorithm of this ScaleFilter.
- Return type
- property width
Gets the width of this ScaleFilter.
The width of the output frame in pixels. If not set it will be based on the configured height by maintaining the original aspect ratio. If height is also not set, the original source dimensions will be applied.
- Returns
The width of this ScaleFilter.
- Return type
int
bitmovin_api_sdk.models.scaling_algorithm module
- class bitmovin_api_sdk.models.scaling_algorithm.ScalingAlgorithm(value)[source]
Bases:
EnumAn enumeration.
- AVERAGING_AREA = 'AVERAGING_AREA'
- BICUBIC = 'BICUBIC'
- BICUBIC_LUMA_BILINEAR_CHROMA = 'BICUBIC_LUMA_BILINEAR_CHROMA'
- BILINEAR = 'BILINEAR'
- EXPERIMENTAL = 'EXPERIMENTAL'
- FAST_BILINEAR = 'FAST_BILINEAR'
- GAUSS = 'GAUSS'
- LANCZOS = 'LANCZOS'
- NEAREST_NEIGHBOR = 'NEAREST_NEIGHBOR'
- SINC = 'SINC'
- SPLINE = 'SPLINE'
bitmovin_api_sdk.models.scc_caption module
- class bitmovin_api_sdk.models.scc_caption.SccCaption(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property input
Gets the input of this SccCaption.
Input location of the SCC file (required)
- Returns
The input of this SccCaption.
- Return type
- property openapi_types
- property smpte_timecode_flavor
Gets the smpte_timecode_flavor of this SccCaption.
Flavor of SMPTE timecodes in the SCC file (drop-frame or non-drop)
- Returns
The smpte_timecode_flavor of this SccCaption.
- Return type
bitmovin_api_sdk.models.scheduled_insertable_content module
- class bitmovin_api_sdk.models.scheduled_insertable_content.ScheduledInsertableContent(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property content_id
Gets the content_id of this ScheduledInsertableContent.
Id of the insertable content to play instead of the live stream
- Returns
The content_id of this ScheduledInsertableContent.
- Return type
string_types
- property duration_in_seconds
Gets the duration_in_seconds of this ScheduledInsertableContent.
Duration for how long to play the content. Cut off if shorter, loop if longer than actual duration. This property is required if the insertable content is an image.
- Returns
The duration_in_seconds of this ScheduledInsertableContent.
- Return type
float
- property openapi_types
- property run_at
Gets the run_at of this ScheduledInsertableContent.
Time to play the content in UTC: YYYY-MM-DDThh:mm:ssZ, if this property is not set the content will be played as soon as possible.
- Returns
The run_at of this ScheduledInsertableContent.
- Return type
datetime
- property status
Gets the status of this ScheduledInsertableContent.
Status of the scheduled insertable content.
- Returns
The status of this ScheduledInsertableContent.
- Return type
bitmovin_api_sdk.models.scheduled_insertable_content_status module
bitmovin_api_sdk.models.scheduling module
- class bitmovin_api_sdk.models.scheduling.Scheduling(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property prewarmed_encoder_pool_ids
Gets the prewarmed_encoder_pool_ids of this Scheduling.
List of prewarmed encoder pools. If set, prewarmed encoders from pools with these IDs will be used for the encoding if available. The pool IDs will be tried in the order in which they are passed.
- Returns
The prewarmed_encoder_pool_ids of this Scheduling.
- Return type
list[string_types]
- property priority
Gets the priority of this Scheduling.
Specifies the priority of this encoding (0 - 100). Higher numbers mean higher priority. Default is 50.
- Returns
The priority of this Scheduling.
- Return type
int
bitmovin_api_sdk.models.scte35_cue module
- class bitmovin_api_sdk.models.scte35_cue.Scte35Cue(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property cue_duration
Gets the cue_duration of this Scte35Cue.
Cue out duration in seconds. (required)
- Returns
The cue_duration of this Scte35Cue.
- Return type
float
- property manifest_ids
Gets the manifest_ids of this Scte35Cue.
The ids of the manifests to update. If this property is not set, all the manifests tied to the encoding are updated.
- Returns
The manifest_ids of this Scte35Cue.
- Return type
list[string_types]
- property openapi_types
bitmovin_api_sdk.models.segmented_raw_muxing module
- class bitmovin_api_sdk.models.segmented_raw_muxing.SegmentedRawMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property openapi_types
- property segment_length
Gets the segment_length of this SegmentedRawMuxing.
Length of the fragments in seconds (required)
- Returns
The segment_length of this SegmentedRawMuxing.
- Return type
float
- property segment_naming
Gets the segment_naming of this SegmentedRawMuxing.
Segment naming policy (required)
- Returns
The segment_naming of this SegmentedRawMuxing.
- Return type
string_types
- property segments_muxed
Gets the segments_muxed of this SegmentedRawMuxing.
Number of segments which have been encoded
- Returns
The segments_muxed of this SegmentedRawMuxing.
- Return type
int
bitmovin_api_sdk.models.segments_media_info module
- class bitmovin_api_sdk.models.segments_media_info.SegmentsMediaInfo(**kwargs)[source]
Bases:
BasicMediaInfo- property attribute_map
- property drm_id
Gets the drm_id of this SegmentsMediaInfo.
Id of the DRM.
- Returns
The drm_id of this SegmentsMediaInfo.
- Return type
string_types
- property encoding_id
Gets the encoding_id of this SegmentsMediaInfo.
Id of the encoding. (required)
- Returns
The encoding_id of this SegmentsMediaInfo.
- Return type
string_types
- property end_segment_number
Gets the end_segment_number of this SegmentsMediaInfo.
Number of the last segment. Default is the last one that was encoded.
- Returns
The end_segment_number of this SegmentsMediaInfo.
- Return type
int
- property muxing_id
Gets the muxing_id of this SegmentsMediaInfo.
Id of the muxing. (required)
- Returns
The muxing_id of this SegmentsMediaInfo.
- Return type
string_types
- property openapi_types
- property segment_path
Gets the segment_path of this SegmentsMediaInfo.
Path to segments. (required)
- Returns
The segment_path of this SegmentsMediaInfo.
- Return type
string_types
- property start_segment_number
Gets the start_segment_number of this SegmentsMediaInfo.
Number of the first segment. Default is 0.
- Returns
The start_segment_number of this SegmentsMediaInfo.
- Return type
int
- property stream_id
Gets the stream_id of this SegmentsMediaInfo.
Id of the stream. (required)
- Returns
The stream_id of this SegmentsMediaInfo.
- Return type
string_types
bitmovin_api_sdk.models.sftp_input module
- class bitmovin_api_sdk.models.sftp_input.SftpInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property host
Gets the host of this SftpInput.
Host Url or IP of the SFTP server (required)
- Returns
The host of this SftpInput.
- Return type
string_types
- property openapi_types
- property passive
Gets the passive of this SftpInput.
Use passive mode. Default is true.
- Returns
The passive of this SftpInput.
- Return type
bool
- property password
Gets the password of this SftpInput.
Your SFTP password
- Returns
The password of this SftpInput.
- Return type
string_types
- property port
Gets the port of this SftpInput.
Port to use, standard for SFTP: 22
- Returns
The port of this SftpInput.
- Return type
int
- property username
Gets the username of this SftpInput.
Your SFTP Username
- Returns
The username of this SftpInput.
- Return type
string_types
bitmovin_api_sdk.models.sftp_output module
- class bitmovin_api_sdk.models.sftp_output.SftpOutput(**kwargs)[source]
Bases:
Output- property attribute_map
- property host
Gets the host of this SftpOutput.
Host Url or IP of the SFTP server (required)
- Returns
The host of this SftpOutput.
- Return type
string_types
- property max_concurrent_connections
Gets the max_concurrent_connections of this SftpOutput.
Restrict maximum concurrent connections. Requires at least version 1.1.0.
- Returns
The max_concurrent_connections of this SftpOutput.
- Return type
int
- property openapi_types
- property passive
Gets the passive of this SftpOutput.
Use passive mode. Default is true.
- Returns
The passive of this SftpOutput.
- Return type
bool
- property password
Gets the password of this SftpOutput.
Your SFTP password
- Returns
The password of this SftpOutput.
- Return type
string_types
- property port
Gets the port of this SftpOutput.
Port to use, standard for SFTP: 22
- Returns
The port of this SftpOutput.
- Return type
int
- property transfer_version
Gets the transfer_version of this SftpOutput.
Controls which transfer version should be used
- Returns
The transfer_version of this SftpOutput.
- Return type
- property username
Gets the username of this SftpOutput.
Your SFTP Username
- Returns
The username of this SftpOutput.
- Return type
string_types
bitmovin_api_sdk.models.sidecar_error_mode module
bitmovin_api_sdk.models.sidecar_file module
- class bitmovin_api_sdk.models.sidecar_file.SidecarFile(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- discriminator_value_class_map = {'WEB_VTT': 'WebVttSidecarFile'}
- property error_mode
Gets the error_mode of this SidecarFile.
This defines how errors should be handled
- Returns
The error_mode of this SidecarFile.
- Return type
- property input_id
Gets the input_id of this SidecarFile.
Id of input (required)
- Returns
The input_id of this SidecarFile.
- Return type
string_types
- property input_path
Gets the input_path of this SidecarFile.
Path to sidecar file (required)
- Returns
The input_path of this SidecarFile.
- Return type
string_types
- property openapi_types
- property outputs
Gets the outputs of this SidecarFile.
- Returns
The outputs of this SidecarFile.
- Return type
list[EncodingOutput]
bitmovin_api_sdk.models.sidecar_file_type module
bitmovin_api_sdk.models.signature_type module
bitmovin_api_sdk.models.signup_source module
bitmovin_api_sdk.models.simple_encoding_live_cloud_region module
bitmovin_api_sdk.models.simple_encoding_live_job_access_key_credentials module
- class bitmovin_api_sdk.models.simple_encoding_live_job_access_key_credentials.SimpleEncodingLiveJobAccessKeyCredentials(**kwargs)[source]
Bases:
SimpleEncodingLiveJobCredentials- property access_key
Gets the access_key of this SimpleEncodingLiveJobAccessKeyCredentials.
The identifier of the access key (required)
- Returns
The access_key of this SimpleEncodingLiveJobAccessKeyCredentials.
- Return type
string_types
- property attribute_map
- property openapi_types
- property secret_key
Gets the secret_key of this SimpleEncodingLiveJobAccessKeyCredentials.
The secret to be used for authentication (required)
- Returns
The secret_key of this SimpleEncodingLiveJobAccessKeyCredentials.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_live_job_azure_credentials module
- class bitmovin_api_sdk.models.simple_encoding_live_job_azure_credentials.SimpleEncodingLiveJobAzureCredentials(**kwargs)[source]
Bases:
SimpleEncodingLiveJobCredentials- property attribute_map
- property key
Gets the key of this SimpleEncodingLiveJobAzureCredentials.
Azure Account Key used for authentication (required)
- Returns
The key of this SimpleEncodingLiveJobAzureCredentials.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.simple_encoding_live_job_cdn_output module
bitmovin_api_sdk.models.simple_encoding_live_job_credentials module
bitmovin_api_sdk.models.simple_encoding_live_job_gcs_service_account_credentials module
- class bitmovin_api_sdk.models.simple_encoding_live_job_gcs_service_account_credentials.SimpleEncodingLiveJobGcsServiceAccountCredentials(**kwargs)[source]
Bases:
SimpleEncodingLiveJobCredentials- property attribute_map
- property openapi_types
- property service_account_credentials
Gets the service_account_credentials of this SimpleEncodingLiveJobGcsServiceAccountCredentials.
Service account credentials for Google (required)
- Returns
The service_account_credentials of this SimpleEncodingLiveJobGcsServiceAccountCredentials.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_live_job_input module
- class bitmovin_api_sdk.models.simple_encoding_live_job_input.SimpleEncodingLiveJobInput(**kwargs)[source]
Bases:
object- property attribute_map
- property input_type
Gets the input_type of this SimpleEncodingLiveJobInput.
Defines which protocol is being used as input of the live stream.
- Returns
The input_type of this SimpleEncodingLiveJobInput.
- Return type
- property openapi_types
bitmovin_api_sdk.models.simple_encoding_live_job_input_type module
bitmovin_api_sdk.models.simple_encoding_live_job_output module
- class bitmovin_api_sdk.models.simple_encoding_live_job_output.SimpleEncodingLiveJobOutput(**kwargs)[source]
Bases:
object- property attribute_map
- discriminator_value_class_map = {'CDN': 'SimpleEncodingLiveJobCdnOutput', 'URL': 'SimpleEncodingLiveJobUrlOutput'}
- property max_resolution
Gets the max_resolution of this SimpleEncodingLiveJobOutput.
The maximum output resolution to be generated
- Returns
The max_resolution of this SimpleEncodingLiveJobOutput.
- Return type
- property openapi_types
bitmovin_api_sdk.models.simple_encoding_live_job_output_type module
bitmovin_api_sdk.models.simple_encoding_live_job_request module
- class bitmovin_api_sdk.models.simple_encoding_live_job_request.SimpleEncodingLiveJobRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property cloud_region
Gets the cloud_region of this SimpleEncodingLiveJobRequest.
The cloud region that will be used for the live encoding. This value has to be set.
- Returns
The cloud_region of this SimpleEncodingLiveJobRequest.
- Return type
- property encoding_profile
Gets the encoding_profile of this SimpleEncodingLiveJobRequest.
The profile that will be used for the live encoding.
- Returns
The encoding_profile of this SimpleEncodingLiveJobRequest.
- Return type
- property input
Gets the input of this SimpleEncodingLiveJobRequest.
Please take a look at the [documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api-live#inputs) (required)
- Returns
The input of this SimpleEncodingLiveJobRequest.
- Return type
- property name
Gets the name of this SimpleEncodingLiveJobRequest.
This property will be used for naming the encoding.
- Returns
The name of this SimpleEncodingLiveJobRequest.
- Return type
string_types
- property openapi_types
- property outputs
Gets the outputs of this SimpleEncodingLiveJobRequest.
Please take a look at the [documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api-live#outputs) (required)
- Returns
The outputs of this SimpleEncodingLiveJobRequest.
- Return type
bitmovin_api_sdk.models.simple_encoding_live_job_response module
- class bitmovin_api_sdk.models.simple_encoding_live_job_response.SimpleEncodingLiveJobResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property cloud_region
Gets the cloud_region of this SimpleEncodingLiveJobResponse.
The cloud region that will be used for the live encoding
- Returns
The cloud_region of this SimpleEncodingLiveJobResponse.
- Return type
- property created_at
Gets the created_at of this SimpleEncodingLiveJobResponse.
Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this SimpleEncodingLiveJobResponse.
- Return type
datetime
- property encoder_ip
Gets the encoder_ip of this SimpleEncodingLiveJobResponse.
The IP address of the encoder for this job request. This is only returned once the job execution has been successful and the encoding could be started. Ingest is expected to be sent to this IP address.
- Returns
The encoder_ip of this SimpleEncodingLiveJobResponse.
- Return type
string_types
- property encoding_id
Gets the encoding_id of this SimpleEncodingLiveJobResponse.
The identifier of the encoding that has been created based on the job request. This is only returned once the job execution has been successful and the encoding could be started.
- Returns
The encoding_id of this SimpleEncodingLiveJobResponse.
- Return type
string_types
- property encoding_profile
Gets the encoding_profile of this SimpleEncodingLiveJobResponse.
The profile that will be used for the live encoding.
- Returns
The encoding_profile of this SimpleEncodingLiveJobResponse.
- Return type
- property errors
Gets the errors of this SimpleEncodingLiveJobResponse.
Describes all the errors in cases the status of the job is ‘error’.
- Returns
The errors of this SimpleEncodingLiveJobResponse.
- Return type
- property id
Gets the id of this SimpleEncodingLiveJobResponse.
The identifier of the Simple Encoding Live Job
- Returns
The id of this SimpleEncodingLiveJobResponse.
- Return type
string_types
- property input
Gets the input of this SimpleEncodingLiveJobResponse.
- Returns
The input of this SimpleEncodingLiveJobResponse.
- Return type
- property modified_at
Gets the modified_at of this SimpleEncodingLiveJobResponse.
Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The job is updated for example when the status changes
- Returns
The modified_at of this SimpleEncodingLiveJobResponse.
- Return type
datetime
- property name
Gets the name of this SimpleEncodingLiveJobResponse.
This property will be used for naming the encoding and the manifests.
- Returns
The name of this SimpleEncodingLiveJobResponse.
- Return type
string_types
- property openapi_types
- property outputs
Gets the outputs of this SimpleEncodingLiveJobResponse.
- Returns
The outputs of this SimpleEncodingLiveJobResponse.
- Return type
- property status
Gets the status of this SimpleEncodingLiveJobResponse.
The current status of the Simple Encoding Live Job
- Returns
The status of this SimpleEncodingLiveJobResponse.
- Return type
- property stream_key
Gets the stream_key of this SimpleEncodingLiveJobResponse.
Stream key of the live encoder
- Returns
The stream_key of this SimpleEncodingLiveJobResponse.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_live_job_s3_role_based_credentials module
- class bitmovin_api_sdk.models.simple_encoding_live_job_s3_role_based_credentials.SimpleEncodingLiveJobS3RoleBasedCredentials(**kwargs)[source]
Bases:
SimpleEncodingLiveJobCredentials- property attribute_map
- property openapi_types
- property role_arn
Gets the role_arn of this SimpleEncodingLiveJobS3RoleBasedCredentials.
Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. More details can be found [here](https://bitmovin.com/docs/encoding/api-reference/sections/inputs#/Encoding/PostEncodingInputsS3RoleBased) (required)
- Returns
The role_arn of this SimpleEncodingLiveJobS3RoleBasedCredentials.
- Return type
string_types
- property use_external_id
Gets the use_external_id of this SimpleEncodingLiveJobS3RoleBasedCredentials.
Defines if the organization ID has to be used as externalId when assuming the role. More details can be found [here](https://bitmovin.com/docs/encoding/api-reference/sections/inputs#/Encoding/PostEncodingInputsS3RoleBased)
- Returns
The use_external_id of this SimpleEncodingLiveJobS3RoleBasedCredentials.
- Return type
bool
bitmovin_api_sdk.models.simple_encoding_live_job_status module
- class bitmovin_api_sdk.models.simple_encoding_live_job_status.SimpleEncodingLiveJobStatus(value)[source]
Bases:
EnumAn enumeration.
- CANCELED = 'CANCELED'
- CREATED = 'CREATED'
- ERROR = 'ERROR'
- EXECUTING = 'EXECUTING'
- FAILURE = 'FAILURE'
- RUNNING = 'RUNNING'
- STARTING = 'STARTING'
- STOPPED = 'STOPPED'
bitmovin_api_sdk.models.simple_encoding_live_job_url_output module
- class bitmovin_api_sdk.models.simple_encoding_live_job_url_output.SimpleEncodingLiveJobUrlOutput(**kwargs)[source]
Bases:
SimpleEncodingLiveJobOutput- property attribute_map
- property credentials
Gets the credentials of this SimpleEncodingLiveJobUrlOutput.
Credentials to be used for authentication and accessing the folder.
- Returns
The credentials of this SimpleEncodingLiveJobUrlOutput.
- Return type
- property make_public
Gets the make_public of this SimpleEncodingLiveJobUrlOutput.
Indicates if the output should be publically available so that playback immediately works over the internet. Note that not every storage provider supports public output, in this case the flag will be ignored (e.g., Akamai NetStorage). It might forbidden by some storage configuration to make files public, for example an S3 buckets can be configured to disallow public access. In this case set it to false.
- Returns
The make_public of this SimpleEncodingLiveJobUrlOutput.
- Return type
bool
- property openapi_types
- property url
Gets the url of this SimpleEncodingLiveJobUrlOutput.
Define a URL pointing to a folder which will be used to upload the encoded assets. The output folder structure used looks the following way: <br><br> http://host/my-folder <ul> <li> /video <ul> <li>`/{width}x{height}_{bitrate}/` (multiple subfolders containing different output renditions)</li> </ul> </li> <li>`/audio` </li> <li>`/index.m3u8` (HLS manifest file) </li> <li>`/stream.mpd` (DASH manifest file) </li> </ul> Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocals/storage systems. S3: * s3://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/ It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/ It is required to provide username/password credentials for authentication. (required)
- Returns
The url of this SimpleEncodingLiveJobUrlOutput.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_live_job_username_password_credentials module
- class bitmovin_api_sdk.models.simple_encoding_live_job_username_password_credentials.SimpleEncodingLiveJobUsernamePasswordCredentials(**kwargs)[source]
Bases:
SimpleEncodingLiveJobCredentials- property attribute_map
- property openapi_types
- property password
Gets the password of this SimpleEncodingLiveJobUsernamePasswordCredentials.
The password to be used for authentication (required)
- Returns
The password of this SimpleEncodingLiveJobUsernamePasswordCredentials.
- Return type
string_types
- property username
Gets the username of this SimpleEncodingLiveJobUsernamePasswordCredentials.
The username to be used for authentication. (required)
- Returns
The username of this SimpleEncodingLiveJobUsernamePasswordCredentials.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_live_max_resolution module
bitmovin_api_sdk.models.simple_encoding_live_profile module
bitmovin_api_sdk.models.simple_encoding_vod_job_access_key_credentials module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_access_key_credentials.SimpleEncodingVodJobAccessKeyCredentials(**kwargs)[source]
Bases:
SimpleEncodingVodJobCredentials- property access_key
Gets the access_key of this SimpleEncodingVodJobAccessKeyCredentials.
The identifier of the access key (required)
- Returns
The access_key of this SimpleEncodingVodJobAccessKeyCredentials.
- Return type
string_types
- property attribute_map
- property openapi_types
- property secret_key
Gets the secret_key of this SimpleEncodingVodJobAccessKeyCredentials.
The secret to be used for authentication (required)
- Returns
The secret_key of this SimpleEncodingVodJobAccessKeyCredentials.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_vod_job_azure_credentials module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_azure_credentials.SimpleEncodingVodJobAzureCredentials(**kwargs)[source]
Bases:
SimpleEncodingVodJobCredentials- property attribute_map
- property key
Gets the key of this SimpleEncodingVodJobAzureCredentials.
Azure Account Key used for authentication (required)
- Returns
The key of this SimpleEncodingVodJobAzureCredentials.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.simple_encoding_vod_job_cdn_output module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_cdn_output.SimpleEncodingVodJobCdnOutput(**kwargs)[source]
Bases:
SimpleEncodingVodJobOutput- property attribute_map
- property max_resolution
Gets the max_resolution of this SimpleEncodingVodJobCdnOutput.
The maximum output resolution to be generated
- Returns
The max_resolution of this SimpleEncodingVodJobCdnOutput.
- Return type
- property openapi_types
bitmovin_api_sdk.models.simple_encoding_vod_job_credentials module
bitmovin_api_sdk.models.simple_encoding_vod_job_direct_file_upload_input module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_direct_file_upload_input.SimpleEncodingVodJobDirectFileUploadInput(**kwargs)[source]
Bases:
SimpleEncodingVodJobInput- property attribute_map
- property input_id
Gets the input_id of this SimpleEncodingVodJobDirectFileUploadInput.
Id of a DirectFileUploadInput (required)
- Returns
The input_id of this SimpleEncodingVodJobDirectFileUploadInput.
- Return type
string_types
- property input_type
Gets the input_type of this SimpleEncodingVodJobDirectFileUploadInput.
Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams. Note that when defining video and audio inputs, you can either - add one single input without inputType, in which case that source file must contain a video stream and (if you want audio) one audio stream, or - add one single input with inputType=VIDEO and (if you want audio) one or more inputs with inputType=AUDIO (each containing one audio stream) Other combinations are not valid.
- Returns
The input_type of this SimpleEncodingVodJobDirectFileUploadInput.
- Return type
- property language
Gets the language of this SimpleEncodingVodJobDirectFileUploadInput.
The language of the audio track, the subtitles, or closed captions file. The language code must be compliant with [BCP 47](https://datatracker.ietf.org/doc/html/rfc5646). This property is mandatory if the input provided is of type SUBTITLES or CLOSED_CAPTIONS and recommended for input type AUDIO and an input that does not specify an input type (combined audio and video). If an audio input does not specify the language, it is defaulted to und (undefined).
- Returns
The language of this SimpleEncodingVodJobDirectFileUploadInput.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.simple_encoding_vod_job_errors module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_errors.SimpleEncodingVodJobErrors(**kwargs)[source]
Bases:
object- property attribute_map
- property details
Gets the details of this SimpleEncodingVodJobErrors.
Additional details of the error if available.
- Returns
The details of this SimpleEncodingVodJobErrors.
- Return type
string_types
- property error_code
Gets the error_code of this SimpleEncodingVodJobErrors.
Stable code that identifies the error type.
- Returns
The error_code of this SimpleEncodingVodJobErrors.
- Return type
string_types
- property message
Gets the message of this SimpleEncodingVodJobErrors.
Human readable description of the error.
- Returns
The message of this SimpleEncodingVodJobErrors.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.simple_encoding_vod_job_gcs_service_account_credentials module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_gcs_service_account_credentials.SimpleEncodingVodJobGcsServiceAccountCredentials(**kwargs)[source]
Bases:
SimpleEncodingVodJobCredentials- property attribute_map
- property openapi_types
- property service_account_credentials
Gets the service_account_credentials of this SimpleEncodingVodJobGcsServiceAccountCredentials.
Service account credentials for Google (required)
- Returns
The service_account_credentials of this SimpleEncodingVodJobGcsServiceAccountCredentials.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_vod_job_input module
bitmovin_api_sdk.models.simple_encoding_vod_job_input_source_type module
bitmovin_api_sdk.models.simple_encoding_vod_job_input_type module
bitmovin_api_sdk.models.simple_encoding_vod_job_options module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_options.SimpleEncodingVodJobOptions(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property single_file_output
Gets the single_file_output of this SimpleEncodingVodJobOptions.
Defines if the job should additionally produce a single file as output (e.g., an MP4) for every rendition the Per-Title algorithm produces. This can be useful to provide customers with features such as downloading of videos for different screen sizes. The single file contains both audio and video streams along the segmented output. Note that currently we do not include subtitles in this file.
- Returns
The single_file_output of this SimpleEncodingVodJobOptions.
- Return type
bool
bitmovin_api_sdk.models.simple_encoding_vod_job_output module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_output.SimpleEncodingVodJobOutput(**kwargs)[source]
Bases:
object- property artifacts
Gets the artifacts of this SimpleEncodingVodJobOutput.
List of artifacts created by the encoding job. Artifacts are files essential for playback of the generated content, e.g. manifests.
- Returns
The artifacts of this SimpleEncodingVodJobOutput.
- Return type
- property attribute_map
- discriminator_value_class_map = {'CDN': 'SimpleEncodingVodJobCdnOutput', 'URL': 'SimpleEncodingVodJobUrlOutput'}
- property openapi_types
bitmovin_api_sdk.models.simple_encoding_vod_job_output_artifact module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_output_artifact.SimpleEncodingVodJobOutputArtifact(**kwargs)[source]
Bases:
object- property attribute_map
- property name
Gets the name of this SimpleEncodingVodJobOutputArtifact.
Name of the artifact. Currently we provide the URL of the HLS manifest with name ‘HLS_MANIFEST_URL’ and the URL of the DASH manifest with name ‘DASH_MANIFEST_URL’
- Returns
The name of this SimpleEncodingVodJobOutputArtifact.
- Return type
string_types
- property openapi_types
- property value
Gets the value of this SimpleEncodingVodJobOutputArtifact.
A string value described by the ‘name’ property. Typically this is an absolute URL pointing to a file on the output you specified for the encoding job. The protocol depends on the type of output: “s3://” for AWS S3,”gcs://” for Google Cloud Storage, “https://” for Azure Blob Storage and Akamai NetStorage )
- Returns
The value of this SimpleEncodingVodJobOutputArtifact.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_vod_job_output_type module
bitmovin_api_sdk.models.simple_encoding_vod_job_request module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_request.SimpleEncodingVodJobRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property encoding_template
Gets the encoding_template of this SimpleEncodingVodJobRequest.
The template that will be used for the encoding.
- Returns
The encoding_template of this SimpleEncodingVodJobRequest.
- Return type
- property inputs
Gets the inputs of this SimpleEncodingVodJobRequest.
Please take a look at the [documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api#inputs-outputs) (required)
- Returns
The inputs of this SimpleEncodingVodJobRequest.
- Return type
- property name
Gets the name of this SimpleEncodingVodJobRequest.
This property will be used for naming the encoding and the manifests.
- Returns
The name of this SimpleEncodingVodJobRequest.
- Return type
string_types
- property openapi_types
- property options
Gets the options of this SimpleEncodingVodJobRequest.
Options to customize the Simple Encoding Job
- Returns
The options of this SimpleEncodingVodJobRequest.
- Return type
- property outputs
Gets the outputs of this SimpleEncodingVodJobRequest.
Please take a look at the [documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api#inputs-outputs) (required)
- Returns
The outputs of this SimpleEncodingVodJobRequest.
- Return type
bitmovin_api_sdk.models.simple_encoding_vod_job_response module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_response.SimpleEncodingVodJobResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property created_at
Gets the created_at of this SimpleEncodingVodJobResponse.
Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this SimpleEncodingVodJobResponse.
- Return type
datetime
- property encoding_id
Gets the encoding_id of this SimpleEncodingVodJobResponse.
The identifier of the encoding that has been created based on the job request. This is only returned once the job execution has been successful and the encoding could be started.
- Returns
The encoding_id of this SimpleEncodingVodJobResponse.
- Return type
string_types
- property encoding_template
Gets the encoding_template of this SimpleEncodingVodJobResponse.
The template that has been used for the encoding.
- Returns
The encoding_template of this SimpleEncodingVodJobResponse.
- Return type
- property errors
Gets the errors of this SimpleEncodingVodJobResponse.
Describes all the errors in cases the status of the job is ‘error’.
- Returns
The errors of this SimpleEncodingVodJobResponse.
- Return type
- property id
Gets the id of this SimpleEncodingVodJobResponse.
The identifier of the Simple Encoding VOD Job
- Returns
The id of this SimpleEncodingVodJobResponse.
- Return type
string_types
- property inputs
Gets the inputs of this SimpleEncodingVodJobResponse.
- Returns
The inputs of this SimpleEncodingVodJobResponse.
- Return type
- property modified_at
Gets the modified_at of this SimpleEncodingVodJobResponse.
Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The job is updated for example when the status changes
- Returns
The modified_at of this SimpleEncodingVodJobResponse.
- Return type
datetime
- property name
Gets the name of this SimpleEncodingVodJobResponse.
This property will be used for naming the encoding and the manifests.
- Returns
The name of this SimpleEncodingVodJobResponse.
- Return type
string_types
- property openapi_types
- property options
Gets the options of this SimpleEncodingVodJobResponse.
Options to customize the Simple Encoding Job
- Returns
The options of this SimpleEncodingVodJobResponse.
- Return type
- property outputs
Gets the outputs of this SimpleEncodingVodJobResponse.
- Returns
The outputs of this SimpleEncodingVodJobResponse.
- Return type
- property status
Gets the status of this SimpleEncodingVodJobResponse.
The current status of the Simple Encoding VOD Job
- Returns
The status of this SimpleEncodingVodJobResponse.
- Return type
bitmovin_api_sdk.models.simple_encoding_vod_job_s3_role_based_credentials module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_s3_role_based_credentials.SimpleEncodingVodJobS3RoleBasedCredentials(**kwargs)[source]
Bases:
SimpleEncodingVodJobCredentials- property attribute_map
- property openapi_types
- property role_arn
Gets the role_arn of this SimpleEncodingVodJobS3RoleBasedCredentials.
Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. More details can be found [here](https://bitmovin.com/docs/encoding/api-reference/sections/inputs#/Encoding/PostEncodingInputsS3RoleBased) (required)
- Returns
The role_arn of this SimpleEncodingVodJobS3RoleBasedCredentials.
- Return type
string_types
- property use_external_id
Gets the use_external_id of this SimpleEncodingVodJobS3RoleBasedCredentials.
Defines if the organization ID has to be used as externalId when assuming the role. More details can be found [here](https://bitmovin.com/docs/encoding/api-reference/sections/inputs#/Encoding/PostEncodingInputsS3RoleBased)
- Returns
The use_external_id of this SimpleEncodingVodJobS3RoleBasedCredentials.
- Return type
bool
bitmovin_api_sdk.models.simple_encoding_vod_job_status module
bitmovin_api_sdk.models.simple_encoding_vod_job_url_input module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_url_input.SimpleEncodingVodJobUrlInput(**kwargs)[source]
Bases:
SimpleEncodingVodJobInput- property attribute_map
- property credentials
Gets the credentials of this SimpleEncodingVodJobUrlInput.
Credentials to be used for authentication and accessing the file. Check out the examples on how to define the credentials correctly.
- Returns
The credentials of this SimpleEncodingVodJobUrlInput.
- Return type
- property input_type
Gets the input_type of this SimpleEncodingVodJobUrlInput.
Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams. Note that when defining video and audio inputs, you can either - add one single input without inputType, in which case that source file must contain a video stream and (if you want audio) one audio stream, or - add one single input with inputType=VIDEO and (if you want audio) one or more inputs with inputType=AUDIO (each containing one audio stream) Other combinations are not valid.
- Returns
The input_type of this SimpleEncodingVodJobUrlInput.
- Return type
- property language
Gets the language of this SimpleEncodingVodJobUrlInput.
The language of the audio track, the subtitles, or closed captions file. The language code must be compliant with [BCP 47](https://datatracker.ietf.org/doc/html/rfc5646). This property is mandatory if the input provided is of type SUBTITLES or CLOSED_CAPTIONS and recommended for input type AUDIO and an input that does not specify an input type (combined audio and video). If an audio input does not specify the language, it is defaulted to und (undefined).
- Returns
The language of this SimpleEncodingVodJobUrlInput.
- Return type
string_types
- property openapi_types
- property url
Gets the url of this SimpleEncodingVodJobUrlInput.
Define a URL pointing to the asset that should be encoded. The URL has to point to a file. Currently the following protocols/storages systems are supported: HTTP(S), (S)FTP, S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocols/storage systems. — HTTP and HTTPS: * http://<host>[:<port>]/path/file.mp4 * https://<host>[:<port>]/path/file.mp4 The port is defaulted to 80 if it’s not provided. If the content is secured by Basic Authentication please provide corresponding credentials. FTP and SFTP: * ftp://<host>[:<port>]/path/file.mp4 * sftp://<host>[:<port>]/path/file.mp4 The port is defaulted to 21 (ftp) or 22 (sftp) if it’s not provided. If the content is secured please provide corresponding credentials. S3: * s3://<my-bucket>/path/file.mp4 Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/file.mp4 Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/file.mp4 It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/file.mp4 It is required to provide username/password credentials for authentication. (required)
- Returns
The url of this SimpleEncodingVodJobUrlInput.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_vod_job_url_output module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_url_output.SimpleEncodingVodJobUrlOutput(**kwargs)[source]
Bases:
SimpleEncodingVodJobOutput- property attribute_map
- property credentials
Gets the credentials of this SimpleEncodingVodJobUrlOutput.
Credentials to be used for authentication and accessing the folder
- Returns
The credentials of this SimpleEncodingVodJobUrlOutput.
- Return type
- property make_public
Gets the make_public of this SimpleEncodingVodJobUrlOutput.
Indicates if the output should be publically available so that playback immediately works over the internet. Note that not every storage provider supports public output, in this case the flag will be ignored (e.g., Akamai NetStorage). It might forbidden by some storage configuration to make files public, for example an S3 buckets can be configured to disallow public access. In this case set it to false.
- Returns
The make_public of this SimpleEncodingVodJobUrlOutput.
- Return type
bool
- property openapi_types
- property url
Gets the url of this SimpleEncodingVodJobUrlOutput.
Define a URL pointing to a folder which will be used to upload the encoded assets. The output folder structure used looks the following way: <br><br> http://host/my-folder <ul> <li> /video <ul> <li>`/h264/{width}x{height}_{bitrate}/` (multiple subfolders containing different output renditions)</li> </ul> </li> <li>`/audio` <ul> <li>`/aac/{language}/` - if language is unique (subfolder containing audio output files)</li> <li>`/aac/{language}_{index}/` - if language is not unique (subfolder containing audio output files)</li> </ul> </li> <li>`/subtitles` (subfolder containing subtitles files)</li> <li>`/captions` (subfolder containing subtitles files)</li> <li>`/sprites` (subfolder containing generated sprites)</li> <li>`/thumbnails` (subfolder containing generated thumbnails)</li> <li>`/index.m3u8` (HLS manifest file) </li> <li>`/stream.mpd` (DASH manifest file) </li> </ul> Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require credentials to access the asset. Check in the descriptions below which properties can or need to be provided within the credentials key. See below how to construct the URLs for the individual protocols/storage systems. ___ Recommendation To ensure uniqueness of output paths accross multiple encodings, make use of the following placeholders in the output’s URL: {uuid} - will be replaced with a random UUID {asset} - will be replaced with the asset file name (only for the input type VIDEO or DEFAULT) Examples: * using the {uuid} placeholder: The output URL s3://<my-bucket>/{uuid}/path/ will be transformed to e.g. s3://<my-bucket>/d59295f3-1548-4bd9-843d-6ac6896dbdb6/path/. * using the {asset} placeholder: Given an input s3://my-bucket/path/filename.mp4 of type VIDEO or DEFAULT, the output URL s3://<my-bucket>/{asset}/path/ will be transformed to s3://<my-bucket>/filename/path/ Notes: - Placeholders can be combined or used multiple times in the same URL. - Placeholders are ignored when used in conjunction with DirectFileUploadInput`s because in this case the asset file name cannot be set. ___ **S3**: * `s3://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. GCS: * gcs://<my-bucket>/path/ Authentication can be done via accesskey/secretkey or a service account Azure Blob Storage (ABS): * https://<account>.blob.core.windows.net/<container>/path/ It is required to provide the Azure key credentials for authentication. Akamai NetStorage: * https://<host>-nsu.akamaihd.net/<CP-code>/path/ It is required to provide username/password credentials for authentication. (required)
- Returns
The url of this SimpleEncodingVodJobUrlOutput.
- Return type
string_types
bitmovin_api_sdk.models.simple_encoding_vod_job_username_password_credentials module
- class bitmovin_api_sdk.models.simple_encoding_vod_job_username_password_credentials.SimpleEncodingVodJobUsernamePasswordCredentials(**kwargs)[source]
Bases:
SimpleEncodingVodJobCredentials- property attribute_map
- property openapi_types
- property password
Gets the password of this SimpleEncodingVodJobUsernamePasswordCredentials.
The password to be used for authentication (required)
- Returns
The password of this SimpleEncodingVodJobUsernamePasswordCredentials.
- Return type
string_types
- property username
Gets the username of this SimpleEncodingVodJobUsernamePasswordCredentials.
The username to be used for authentication. (required)
- Returns
The username of this SimpleEncodingVodJobUsernamePasswordCredentials.
- Return type
string_types
bitmovin_api_sdk.models.smooth_manifest_content_protection module
- class bitmovin_api_sdk.models.smooth_manifest_content_protection.SmoothManifestContentProtection(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property drm_id
Gets the drm_id of this SmoothManifestContentProtection.
Id of the drm. (required)
- Returns
The drm_id of this SmoothManifestContentProtection.
- Return type
string_types
- property encoding_id
Gets the encoding_id of this SmoothManifestContentProtection.
Id of the encoding. (required)
- Returns
The encoding_id of this SmoothManifestContentProtection.
- Return type
string_types
- property muxing_id
Gets the muxing_id of this SmoothManifestContentProtection.
Id of the muxing. (required)
- Returns
The muxing_id of this SmoothManifestContentProtection.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.smooth_manifest_default module
- class bitmovin_api_sdk.models.smooth_manifest_default.SmoothManifestDefault(**kwargs)[source]
Bases:
SmoothStreamingManifest- property attribute_map
- property encoding_id
Gets the encoding_id of this SmoothManifestDefault.
The id of the encoding to create a default manifest for (required)
- Returns
The encoding_id of this SmoothManifestDefault.
- Return type
string_types
- property openapi_types
- property version
Gets the version of this SmoothManifestDefault.
Currently not in use
- Returns
The version of this SmoothManifestDefault.
- Return type
bitmovin_api_sdk.models.smooth_manifest_default_version module
bitmovin_api_sdk.models.smooth_streaming_manifest module
- class bitmovin_api_sdk.models.smooth_streaming_manifest.SmoothStreamingManifest(**kwargs)[source]
Bases:
Manifest- property attribute_map
- property client_manifest_name
Gets the client_manifest_name of this SmoothStreamingManifest.
Filename of the client manifest
- Returns
The client_manifest_name of this SmoothStreamingManifest.
- Return type
string_types
- property openapi_types
- property server_manifest_name
Gets the server_manifest_name of this SmoothStreamingManifest.
Filename of the server manifest
- Returns
The server_manifest_name of this SmoothStreamingManifest.
- Return type
string_types
bitmovin_api_sdk.models.smooth_streaming_representation module
- class bitmovin_api_sdk.models.smooth_streaming_representation.SmoothStreamingRepresentation(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property encoding_id
Gets the encoding_id of this SmoothStreamingRepresentation.
Id of the encoding (required)
- Returns
The encoding_id of this SmoothStreamingRepresentation.
- Return type
string_types
- property language
Gets the language of this SmoothStreamingRepresentation.
Language of the MP4 file
- Returns
The language of this SmoothStreamingRepresentation.
- Return type
string_types
- property media_file
Gets the media_file of this SmoothStreamingRepresentation.
The Smooth Streaming ismv or isma file that will be referenced in the manifest. (required)
- Returns
The media_file of this SmoothStreamingRepresentation.
- Return type
string_types
- property muxing_id
Gets the muxing_id of this SmoothStreamingRepresentation.
Id of the muxing. (required)
- Returns
The muxing_id of this SmoothStreamingRepresentation.
- Return type
string_types
- property openapi_types
- property priority
Gets the priority of this SmoothStreamingRepresentation.
Specifies the priority of this representation. In the manifest, representations will appear ordered by descending priority values.
- Returns
The priority of this SmoothStreamingRepresentation.
- Return type
int
- property track_name
Gets the track_name of this SmoothStreamingRepresentation.
Track where this MP4 shoudl be added
- Returns
The track_name of this SmoothStreamingRepresentation.
- Return type
string_types
bitmovin_api_sdk.models.smpte_timecode_flavor module
bitmovin_api_sdk.models.source_channel module
- class bitmovin_api_sdk.models.source_channel.SourceChannel(**kwargs)[source]
Bases:
object- property attribute_map
- property channel_number
Gets the channel_number of this SourceChannel.
Number of this source channel. If type is ‘CHANNEL_NUMBER’, this must be set.
- Returns
The channel_number of this SourceChannel.
- Return type
int
- property gain
Gets the gain of this SourceChannel.
Gain for this source channel. Default is 1.0.
- Returns
The gain of this SourceChannel.
- Return type
float
- property openapi_types
- property type
Gets the type of this SourceChannel.
- Returns
The type of this SourceChannel.
- Return type
bitmovin_api_sdk.models.source_channel_type module
- class bitmovin_api_sdk.models.source_channel_type.SourceChannelType(value)[source]
Bases:
EnumAn enumeration.
- BACK_LEFT = 'BACK_LEFT'
- BACK_RIGHT = 'BACK_RIGHT'
- CENTER = 'CENTER'
- CHANNEL_NUMBER = 'CHANNEL_NUMBER'
- FRONT_LEFT = 'FRONT_LEFT'
- FRONT_RIGHT = 'FRONT_RIGHT'
- LOW_FREQUENCY = 'LOW_FREQUENCY'
- SURROUND_LEFT = 'SURROUND_LEFT'
- SURROUND_RIGHT = 'SURROUND_RIGHT'
bitmovin_api_sdk.models.speke_drm module
- class bitmovin_api_sdk.models.speke_drm.SpekeDrm(**kwargs)[source]
Bases:
Drm- property attribute_map
- property content_id
Gets the content_id of this SpekeDrm.
Unique Identifier of the content, will be generated if not set
- Returns
The content_id of this SpekeDrm.
- Return type
string_types
- property iv
Gets the iv of this SpekeDrm.
16 byte initialization vector represented by a 32-character text string. It is mandatory if systemIds contains AES128 or FairPlay.
- Returns
The iv of this SpekeDrm.
- Return type
string_types
- property kid
Gets the kid of this SpekeDrm.
Optional key identifier, will be generated if not set. For SPEKE DRM Configurations with the same contentId and kid the key provider will provide the same keys.
- Returns
The kid of this SpekeDrm.
- Return type
string_types
- property openapi_types
- property provider
Gets the provider of this SpekeDrm.
Key provider configuration for SPEKE (required)
- Returns
The provider of this SpekeDrm.
- Return type
- property system_ids
Gets the system_ids of this SpekeDrm.
DRM system identifier of the content protection scheme. At minimum one is expected. Not all systemIds are currently supported, support depends on the muxing type. Relates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/ (required)
- Returns
The system_ids of this SpekeDrm.
- Return type
list[string_types]
bitmovin_api_sdk.models.speke_drm_provider module
- class bitmovin_api_sdk.models.speke_drm_provider.SpekeDrmProvider(**kwargs)[source]
Bases:
object- property api_key
Gets the api_key of this SpekeDrmProvider.
Your API key for authentication via X-API-Key HTTP Header
- Returns
The api_key of this SpekeDrmProvider.
- Return type
string_types
- property attribute_map
- property external_id
Gets the external_id of this SpekeDrmProvider.
External ID used together with the IAM role identified by roleArn to assume access to the SPEKE server on AWS.
- Returns
The external_id of this SpekeDrmProvider.
- Return type
string_types
- property external_id_mode
Gets the external_id_mode of this SpekeDrmProvider.
- Returns
The external_id_mode of this SpekeDrmProvider.
- Return type
- property gateway_region
Gets the gateway_region of this SpekeDrmProvider.
Describes the region of the AWS API Gateway that is used to access the SPEKE server. This property is mandatory when setting ‘roleArn’ and has to indicate in which region the AWS API Gateway is setup. This usually corresponds to the {{region}} one sets in the execute-api policy for the role as described in ‘roleArn’.
- Returns
The gateway_region of this SpekeDrmProvider.
- Return type
string_types
- property openapi_types
- property password
Gets the password of this SpekeDrmProvider.
Your password for Basic Authentication
- Returns
The password of this SpekeDrmProvider.
- Return type
string_types
- property role_arn
Gets the role_arn of this SpekeDrmProvider.
AWS role that will be assumed for the key exchange in case the provider runs on AWS. During the key exchange the role will be assumed to be able to access the key provider. This role is to be created in the customer’s account and must be granted access to the API Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role:
` { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "{{externalId}}" } } } `It is recommended to also set the {{externalId}} due to security reasons but it can also be ommitted. Additionally the role needs a policy similar to the following to be able to invoke the API gateway:` { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "execute-api:Invoke" ], "Resource": [ "arn:aws:execute-api:{{region}}:*:*/*/POST/*" ] } ] } `where {{region}} is the region of the API gateway (for example us-west-2), the same has to be set in the property ‘gatewayRegion’. It’s also possible to set {{region} to * to give the role access to all regions.- Returns
The role_arn of this SpekeDrmProvider.
- Return type
string_types
- property url
Gets the url of this SpekeDrmProvider.
URL of the endpoint (required)
- Returns
The url of this SpekeDrmProvider.
- Return type
string_types
- property username
Gets the username of this SpekeDrmProvider.
Your username for Basic Authentication
- Returns
The username of this SpekeDrmProvider.
- Return type
string_types
bitmovin_api_sdk.models.sprite module
- class bitmovin_api_sdk.models.sprite.Sprite(**kwargs)[source]
Bases:
BitmovinResource- property aspect_mode
Gets the aspect_mode of this Sprite.
Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.
- Returns
The aspect_mode of this Sprite.
- Return type
- property attribute_map
- property creation_mode
Gets the creation_mode of this Sprite.
The creation mode for the thumbnails in the Sprite. Two possible creation modes exist: generate thumbnails starting with the beginning of the video or after the first configured period. When using distance=10 and unit=SECONDS and INTERVAL_END, the first image of the sprite is from the second 10 of the video. When using distance=10 and unit=SECONDS and INTERVAL_START, the first image of the sprite is from the very start of the video, while the second image is from second 10 of the video. It is recommended to use ‘INTERVAL_START’ when using the sprites for trick play so that there is an additional thumbnail from the beginning of the video. Only supported starting with encoder version 2.76.0.
- Returns
The creation_mode of this Sprite.
- Return type
- property distance
Gets the distance of this Sprite.
Distance in the given unit between a screenshot
- Returns
The distance of this Sprite.
- Return type
float
- property filename
Gets the filename of this Sprite.
Filename of the sprite image. If not set, spriteName will be used, but without an extension.
- Returns
The filename of this Sprite.
- Return type
string_types
- property h_tiles
Gets the h_tiles of this Sprite.
Number of rows of images per file. Has to be set together with vTiles. If this property and vTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder ‘%number%’ in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version 2.76.0.
- Returns
The h_tiles of this Sprite.
- Return type
int
- property height
Gets the height of this Sprite.
Height of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required
- Returns
The height of this Sprite.
- Return type
int
- property images_per_file
Gets the images_per_file of this Sprite.
Number of images per file. If more images are generated than specified in this value, multiple sprites will be created. You can use the placeholder ‘%number%’ in the spriteName to specify the naming policy. Either this property must be set or hTiles and vTiles.
- Returns
The images_per_file of this Sprite.
- Return type
int
- property jpeg_config
Gets the jpeg_config of this Sprite.
Additional configuration for JPEG sprite generation. If this property is set the extension of the file must be ‘.jpg.’ or ‘.jpeg’ Only supported starting with encoder version 2.76.0
- Returns
The jpeg_config of this Sprite.
- Return type
- property openapi_types
- property outputs
Gets the outputs of this Sprite.
- Returns
The outputs of this Sprite.
- Return type
list[EncodingOutput]
- property sprite_name
Gets the sprite_name of this Sprite.
Name of the sprite image. File extension “.jpg”/”.jpeg” or “.png” is required. (required)
- Returns
The sprite_name of this Sprite.
- Return type
string_types
- property unit
Gets the unit of this Sprite.
- Returns
The unit of this Sprite.
- Return type
- property v_tiles
Gets the v_tiles of this Sprite.
Number of columns of images per file. Has to be set together with hTiles. If this property and hTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder ‘%number%’ in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version 2.76.0.
- Returns
The v_tiles of this Sprite.
- Return type
int
- property vtt_name
Gets the vtt_name of this Sprite.
Filename of the vtt-file. The file-extension “.vtt” is required.
- Returns
The vtt_name of this Sprite.
- Return type
string_types
- property width
Gets the width of this Sprite.
Width of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required
- Returns
The width of this Sprite.
- Return type
int
bitmovin_api_sdk.models.sprite_creation_mode module
bitmovin_api_sdk.models.sprite_jpeg_config module
- class bitmovin_api_sdk.models.sprite_jpeg_config.SpriteJpegConfig(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property quality
Gets the quality of this SpriteJpegConfig.
Quality of the JPEG file in percent. Allowed values 20 - 100 (required)
- Returns
The quality of this SpriteJpegConfig.
- Return type
int
bitmovin_api_sdk.models.sprite_representation module
- class bitmovin_api_sdk.models.sprite_representation.SpriteRepresentation(**kwargs)[source]
Bases:
DashRepresentation- property attribute_map
- property encoding_id
Gets the encoding_id of this SpriteRepresentation.
UUID of an encoding (required)
- Returns
The encoding_id of this SpriteRepresentation.
- Return type
string_types
- property openapi_types
- property segment_path
Gets the segment_path of this SpriteRepresentation.
Path to sprite segments. Will be used as the representation id in the manifest. (required)
- Returns
The segment_path of this SpriteRepresentation.
- Return type
string_types
- property sprite_id
Gets the sprite_id of this SpriteRepresentation.
UUID of a Sprite (required)
- Returns
The sprite_id of this SpriteRepresentation.
- Return type
string_types
- property stream_id
Gets the stream_id of this SpriteRepresentation.
UUID of a stream (required)
- Returns
The stream_id of this SpriteRepresentation.
- Return type
string_types
bitmovin_api_sdk.models.sprite_unit module
bitmovin_api_sdk.models.srt_input module
- class bitmovin_api_sdk.models.srt_input.SrtInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property backup_srt_inputs
Gets the backup_srt_inputs of this SrtInput.
- Returns
The backup_srt_inputs of this SrtInput.
- Return type
- property host
Gets the host of this SrtInput.
The name or IP of the host providing the SRT stream (only used in CALLER mode)
- Returns
The host of this SrtInput.
- Return type
string_types
- property key_length
Gets the key_length of this SrtInput.
The type of AES encryption determines the length of the key (passphrase). AES-128 uses a 16-character (128-bit) passphrase, and AES-256 uses a 32-character (256-bit) passphrase.
- Returns
The key_length of this SrtInput.
- Return type
int
- property latency
Gets the latency of this SrtInput.
The maximum accepted transmission latency in milliseconds (when both parties set different values, the maximum of the two is used for both)
- Returns
The latency of this SrtInput.
- Return type
int
- property mode
Gets the mode of this SrtInput.
The SRT mode to use (required)
- Returns
The mode of this SrtInput.
- Return type
- property openapi_types
- property passphrase
Gets the passphrase of this SrtInput.
The passphrase used to secure the SRT stream. For AES-128 encryption, you must enter a 16-character passphrase; for AES-256, you must enter a 32-character passphrase
- Returns
The passphrase of this SrtInput.
- Return type
string_types
- property path
Gets the path of this SrtInput.
The path parameter of the SRT stream
- Returns
The path of this SrtInput.
- Return type
string_types
- property port
Gets the port of this SrtInput.
The port to connect to or listen on. Has to be one of [2088, 2089, 2090, 2091] when using LISTENER mode. (required)
- Returns
The port of this SrtInput.
- Return type
int
bitmovin_api_sdk.models.srt_mode module
bitmovin_api_sdk.models.srt_statistic_link module
- class bitmovin_api_sdk.models.srt_statistic_link.SrtStatisticLink(**kwargs)[source]
Bases:
object- property attribute_map
- property bandwidth
Gets the bandwidth of this SrtStatisticLink.
- Returns
The bandwidth of this SrtStatisticLink.
- Return type
float
- property max_bandwidth
Gets the max_bandwidth of this SrtStatisticLink.
- Returns
The max_bandwidth of this SrtStatisticLink.
- Return type
float
- property openapi_types
- property rtt
Gets the rtt of this SrtStatisticLink.
- Returns
The rtt of this SrtStatisticLink.
- Return type
float
bitmovin_api_sdk.models.srt_statistic_recv module
- class bitmovin_api_sdk.models.srt_statistic_recv.SrtStatisticRecv(**kwargs)[source]
Bases:
object- property attribute_map
- property bytes
Gets the bytes of this SrtStatisticRecv.
- Returns
The bytes of this SrtStatisticRecv.
- Return type
int
- property bytes_dropped
Gets the bytes_dropped of this SrtStatisticRecv.
- Returns
The bytes_dropped of this SrtStatisticRecv.
- Return type
int
- property bytes_lost
Gets the bytes_lost of this SrtStatisticRecv.
- Returns
The bytes_lost of this SrtStatisticRecv.
- Return type
int
- property mbit_rate
Gets the mbit_rate of this SrtStatisticRecv.
- Returns
The mbit_rate of this SrtStatisticRecv.
- Return type
float
- property openapi_types
- property packets
Gets the packets of this SrtStatisticRecv.
- Returns
The packets of this SrtStatisticRecv.
- Return type
int
- property packets_belated
Gets the packets_belated of this SrtStatisticRecv.
- Returns
The packets_belated of this SrtStatisticRecv.
- Return type
int
- property packets_dropped
Gets the packets_dropped of this SrtStatisticRecv.
- Returns
The packets_dropped of this SrtStatisticRecv.
- Return type
int
- property packets_lost
Gets the packets_lost of this SrtStatisticRecv.
- Returns
The packets_lost of this SrtStatisticRecv.
- Return type
int
- property packets_retransmitted
Gets the packets_retransmitted of this SrtStatisticRecv.
- Returns
The packets_retransmitted of this SrtStatisticRecv.
- Return type
int
bitmovin_api_sdk.models.srt_statistic_send module
- class bitmovin_api_sdk.models.srt_statistic_send.SrtStatisticSend(**kwargs)[source]
Bases:
object- property attribute_map
- property bytes
Gets the bytes of this SrtStatisticSend.
- Returns
The bytes of this SrtStatisticSend.
- Return type
int
- property bytes_dropped
Gets the bytes_dropped of this SrtStatisticSend.
- Returns
The bytes_dropped of this SrtStatisticSend.
- Return type
int
- property mbit_rate
Gets the mbit_rate of this SrtStatisticSend.
- Returns
The mbit_rate of this SrtStatisticSend.
- Return type
float
- property openapi_types
- property packets
Gets the packets of this SrtStatisticSend.
- Returns
The packets of this SrtStatisticSend.
- Return type
int
- property packets_dropped
Gets the packets_dropped of this SrtStatisticSend.
- Returns
The packets_dropped of this SrtStatisticSend.
- Return type
int
- property packets_lost
Gets the packets_lost of this SrtStatisticSend.
- Returns
The packets_lost of this SrtStatisticSend.
- Return type
int
- property packets_retransmitted
Gets the packets_retransmitted of this SrtStatisticSend.
- Returns
The packets_retransmitted of this SrtStatisticSend.
- Return type
int
bitmovin_api_sdk.models.srt_statistic_window module
- class bitmovin_api_sdk.models.srt_statistic_window.SrtStatisticWindow(**kwargs)[source]
Bases:
object- property attribute_map
- property congestion
Gets the congestion of this SrtStatisticWindow.
- Returns
The congestion of this SrtStatisticWindow.
- Return type
int
- property flight
Gets the flight of this SrtStatisticWindow.
- Returns
The flight of this SrtStatisticWindow.
- Return type
int
- property flow
Gets the flow of this SrtStatisticWindow.
- Returns
The flow of this SrtStatisticWindow.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.srt_statistics module
- class bitmovin_api_sdk.models.srt_statistics.SrtStatistics(**kwargs)[source]
Bases:
object- property attribute_map
- property created_at
Gets the created_at of this SrtStatistics.
Timestamp when the srt statistics event was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this SrtStatistics.
- Return type
datetime
- property encoding_id
Gets the encoding_id of this SrtStatistics.
UUID of an encoding
- Returns
The encoding_id of this SrtStatistics.
- Return type
string_types
- property id
Gets the id of this SrtStatistics.
UUID of the statistic event
- Returns
The id of this SrtStatistics.
- Return type
string_types
- property link
Gets the link of this SrtStatistics.
- Returns
The link of this SrtStatistics.
- Return type
- property openapi_types
- property org_id
Gets the org_id of this SrtStatistics.
UUID of the associated organization
- Returns
The org_id of this SrtStatistics.
- Return type
string_types
- property recv
Gets the recv of this SrtStatistics.
- Returns
The recv of this SrtStatistics.
- Return type
- property send
Gets the send of this SrtStatistics.
- Returns
The send of this SrtStatistics.
- Return type
- property srt_input_id
Gets the srt_input_id of this SrtStatistics.
UUID of the SRT input used to capture this statistics
- Returns
The srt_input_id of this SrtStatistics.
- Return type
string_types
- property srt_input_selected
Gets the srt_input_selected of this SrtStatistics.
Whether the SRT input that generated this statistics was selected (i.e. actively used) at the time or not
- Returns
The srt_input_selected of this SrtStatistics.
- Return type
bool
- property user_id
Gets the user_id of this SrtStatistics.
UUID of the associated api-user
- Returns
The user_id of this SrtStatistics.
- Return type
string_types
- property window
Gets the window of this SrtStatistics.
- Returns
The window of this SrtStatistics.
- Return type
bitmovin_api_sdk.models.srt_to_cea608708_caption module
- class bitmovin_api_sdk.models.srt_to_cea608708_caption.SrtToCea608708Caption(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property cc_channel
Gets the cc_channel of this SrtToCea608708Caption.
The channel number to embed the CEA subtitles in (required)
- Returns
The cc_channel of this SrtToCea608708Caption.
- Return type
- property character_encoding
Gets the character_encoding of this SrtToCea608708Caption.
Character encoding of the input SRT file (required)
- Returns
The character_encoding of this SrtToCea608708Caption.
- Return type
- property input
Gets the input of this SrtToCea608708Caption.
Input location of the SRT file (required)
- Returns
The input of this SrtToCea608708Caption.
- Return type
- property openapi_types
bitmovin_api_sdk.models.standard_media_info module
- class bitmovin_api_sdk.models.standard_media_info.StandardMediaInfo(**kwargs)[source]
Bases:
SegmentsMediaInfo- property attribute_map
- property openapi_types
- property uri
Gets the uri of this StandardMediaInfo.
The URI of the Rendition (required)
- Returns
The uri of this StandardMediaInfo.
- Return type
string_types
bitmovin_api_sdk.models.start_encoding_request module
- class bitmovin_api_sdk.models.start_encoding_request.StartEncodingRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property encoding_mode
Gets the encoding_mode of this StartEncodingRequest.
The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.
- Returns
The encoding_mode of this StartEncodingRequest.
- Return type
- property handle_variable_input_fps
Gets the handle_variable_input_fps of this StartEncodingRequest.
Enable frame dropping/duplication to handle variable frames per seconds of video input streams
- Returns
The handle_variable_input_fps of this StartEncodingRequest.
- Return type
bool
- property manifest_generator
Gets the manifest_generator of this StartEncodingRequest.
Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
- Returns
The manifest_generator of this StartEncodingRequest.
- Return type
- property openapi_types
- property per_title
Gets the per_title of this StartEncodingRequest.
Per-Title settings
- Returns
The per_title of this StartEncodingRequest.
- Return type
- property preview_dash_manifests
Gets the preview_dash_manifests of this StartEncodingRequest.
DASH manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
- Returns
The preview_dash_manifests of this StartEncodingRequest.
- Return type
list[ManifestResource]
- property preview_hls_manifests
Gets the preview_hls_manifests of this StartEncodingRequest.
HLS manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
- Returns
The preview_hls_manifests of this StartEncodingRequest.
- Return type
list[ManifestResource]
- property scheduling
Gets the scheduling of this StartEncodingRequest.
Scheduling parameters of the encoding.
- Returns
The scheduling of this StartEncodingRequest.
- Return type
- property trimming
Gets the trimming of this StartEncodingRequest.
Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.
- Returns
The trimming of this StartEncodingRequest.
- Return type
- property tweaks
Gets the tweaks of this StartEncodingRequest.
Special tweaks for your encoding job.
- Returns
The tweaks of this StartEncodingRequest.
- Return type
- property vod_dash_manifests
Gets the vod_dash_manifests of this StartEncodingRequest.
DASH manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
- Returns
The vod_dash_manifests of this StartEncodingRequest.
- Return type
list[ManifestResource]
- property vod_hls_manifests
Gets the vod_hls_manifests of this StartEncodingRequest.
HLS manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
- Returns
The vod_hls_manifests of this StartEncodingRequest.
- Return type
list[ManifestResource]
- property vod_smooth_manifests
Gets the vod_smooth_manifests of this StartEncodingRequest.
Smooth Streaming manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
- Returns
The vod_smooth_manifests of this StartEncodingRequest.
- Return type
list[ManifestResource]
bitmovin_api_sdk.models.start_live_channel_encoding_request module
bitmovin_api_sdk.models.start_live_encoding_request module
- class bitmovin_api_sdk.models.start_live_encoding_request.StartLiveEncodingRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property auto_restart_configuration
Gets the auto_restart_configuration of this StartLiveEncodingRequest.
Configuration for auto restarting the live encoding
- Returns
The auto_restart_configuration of this StartLiveEncodingRequest.
- Return type
- property auto_shutdown_configuration
Gets the auto_shutdown_configuration of this StartLiveEncodingRequest.
Configuration for auto shutdown of the live encoding
- Returns
The auto_shutdown_configuration of this StartLiveEncodingRequest.
- Return type
- property dash_manifests
Gets the dash_manifests of this StartLiveEncodingRequest.
DASH manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
- Returns
The dash_manifests of this StartLiveEncodingRequest.
- Return type
list[LiveDashManifest]
- property hls_manifests
Gets the hls_manifests of this StartLiveEncodingRequest.
HLS manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
- Returns
The hls_manifests of this StartLiveEncodingRequest.
- Return type
list[LiveHlsManifest]
- property live_encoding_mode
Gets the live_encoding_mode of this StartLiveEncodingRequest.
The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.
- Returns
The live_encoding_mode of this StartLiveEncodingRequest.
- Return type
- property manifest_generator
Gets the manifest_generator of this StartLiveEncodingRequest.
Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
- Returns
The manifest_generator of this StartLiveEncodingRequest.
- Return type
- property openapi_types
- property reupload_settings
Gets the reupload_settings of this StartLiveEncodingRequest.
Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage
- Returns
The reupload_settings of this StartLiveEncodingRequest.
- Return type
- property stream_key
Gets the stream_key of this StartLiveEncodingRequest.
Key for the stream. (a-zA-Z, 3-20 characters) (required)
- Returns
The stream_key of this StartLiveEncodingRequest.
- Return type
string_types
bitmovin_api_sdk.models.start_manifest_request module
- class bitmovin_api_sdk.models.start_manifest_request.StartManifestRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property manifest_generator
Gets the manifest_generator of this StartManifestRequest.
Major version of the manifest generator to be used. V2 is the recommended option and requires the following minimum encoder versions: 2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
- Returns
The manifest_generator of this StartManifestRequest.
- Return type
- property openapi_types
bitmovin_api_sdk.models.static_ip module
- class bitmovin_api_sdk.models.static_ip.StaticIp(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property infrastructure_id
Gets the infrastructure_id of this StaticIp.
Required if the static IP should be created for an AWS infrastructure account. If this is left blank the static Ip will be created for the managed cloud.
- Returns
The infrastructure_id of this StaticIp.
- Return type
string_types
- property ip_address
Gets the ip_address of this StaticIp.
The IPv4 address of the static ip
- Returns
The ip_address of this StaticIp.
- Return type
string_types
- property openapi_types
- property region
Gets the region of this StaticIp.
The region of the static Ip (required)
- Returns
The region of this StaticIp.
- Return type
- property status
Gets the status of this StaticIp.
Status of the Static Ip
- Returns
The status of this StaticIp.
- Return type
bitmovin_api_sdk.models.static_ip_status module
bitmovin_api_sdk.models.static_rtmp_ingest_point module
- class bitmovin_api_sdk.models.static_rtmp_ingest_point.StaticRtmpIngestPoint(**kwargs)[source]
Bases:
object- property attribute_map
- property id
Gets the id of this StaticRtmpIngestPoint.
The ID of the created static rtmp ingest point
- Returns
The id of this StaticRtmpIngestPoint.
- Return type
string_types
- property name
Gets the name of this StaticRtmpIngestPoint.
Name of the ingest point. This can be helpful for easier identifying your ingest points
- Returns
The name of this StaticRtmpIngestPoint.
- Return type
string_types
- property openapi_types
- property stream_key_configuration
Gets the stream_key_configuration of this StaticRtmpIngestPoint.
- Returns
The stream_key_configuration of this StaticRtmpIngestPoint.
- Return type
bitmovin_api_sdk.models.statistics module
- class bitmovin_api_sdk.models.statistics.Statistics(**kwargs)[source]
Bases:
object- property attribute_map
- property bytes_egress_total
Gets the bytes_egress_total of this Statistics.
Egress output generated by file transfers in bytes
- Returns
The bytes_egress_total of this Statistics.
- Return type
int
- property bytes_encoded_total
Gets the bytes_encoded_total of this Statistics.
Bytes encoded total. (required)
- Returns
The bytes_encoded_total of this Statistics.
- Return type
int
- property openapi_types
- property time_encoded_total
Gets the time_encoded_total of this Statistics.
Time in seconds encoded for all contained daily statistics. (required)
- Returns
The time_encoded_total of this Statistics.
- Return type
int
bitmovin_api_sdk.models.statistics_per_label module
- class bitmovin_api_sdk.models.statistics_per_label.StatisticsPerLabel(**kwargs)[source]
Bases:
Statistics- property attribute_map
- property billable_egress_bytes
Gets the billable_egress_bytes of this StatisticsPerLabel.
Billable egress output
- Returns
The billable_egress_bytes of this StatisticsPerLabel.
- Return type
list[EgressInformation]
- property billable_encoding_minutes
Gets the billable_encoding_minutes of this StatisticsPerLabel.
Billable minutes for each encoding configuration
- Returns
The billable_encoding_minutes of this StatisticsPerLabel.
- Return type
list[BillableEncodingMinutes]
- property billable_feature_minutes
Gets the billable_feature_minutes of this StatisticsPerLabel.
Billable minutes for features
- Returns
The billable_feature_minutes of this StatisticsPerLabel.
- Return type
- property billable_minutes
Gets the billable_minutes of this StatisticsPerLabel.
The billable minutes.
- Returns
The billable_minutes of this StatisticsPerLabel.
- Return type
float
- property billable_transmuxing_minutes
Gets the billable_transmuxing_minutes of this StatisticsPerLabel.
Billable minutes for muxings.
- Returns
The billable_transmuxing_minutes of this StatisticsPerLabel.
- Return type
float
- property label
Gets the label of this StatisticsPerLabel.
An optional error message, when the event is in error state (occurs at event: ERROR) (required)
- Returns
The label of this StatisticsPerLabel.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.statistics_per_muxing module
- class bitmovin_api_sdk.models.statistics_per_muxing.StatisticsPerMuxing(**kwargs)[source]
Bases:
object- property attribute_map
- property billable_minutes
Gets the billable_minutes of this StatisticsPerMuxing.
Resulting minutes you will be charged for. (required)
- Returns
The billable_minutes of this StatisticsPerMuxing.
- Return type
float
- property encoded_bytes
Gets the encoded_bytes of this StatisticsPerMuxing.
Encoded bytes. (required)
- Returns
The encoded_bytes of this StatisticsPerMuxing.
- Return type
int
- property multiplicator
Gets the multiplicator of this StatisticsPerMuxing.
Multiplier for the encoded minutes. Depends on muxing type. (required)
- Returns
The multiplicator of this StatisticsPerMuxing.
- Return type
float
- property muxing_id
Gets the muxing_id of this StatisticsPerMuxing.
ID of the muxing (required)
- Returns
The muxing_id of this StatisticsPerMuxing.
- Return type
string_types
- property muxing_type
Gets the muxing_type of this StatisticsPerMuxing.
- Returns
The muxing_type of this StatisticsPerMuxing.
- Return type
- property openapi_types
- property stream_id
Gets the stream_id of this StatisticsPerMuxing.
ID of the stream (required)
- Returns
The stream_id of this StatisticsPerMuxing.
- Return type
string_types
bitmovin_api_sdk.models.statistics_per_stream module
- class bitmovin_api_sdk.models.statistics_per_stream.StatisticsPerStream(**kwargs)[source]
Bases:
object- property attribute_map
- property billable_minutes
Gets the billable_minutes of this StatisticsPerStream.
Minutes you will be charged for (billableMinutes = encodedSeconds * multiplicator) (required)
- Returns
The billable_minutes of this StatisticsPerStream.
- Return type
float
- property bitrate
Gets the bitrate of this StatisticsPerStream.
Bitrate of the stream (required)
- Returns
The bitrate of this StatisticsPerStream.
- Return type
int
- property codec
Gets the codec of this StatisticsPerStream.
- Returns
The codec of this StatisticsPerStream.
- Return type
- property codec_config_id
Gets the codec_config_id of this StatisticsPerStream.
ID of the condec configuration (required)
- Returns
The codec_config_id of this StatisticsPerStream.
- Return type
string_types
- property dolby_vision_mode
Gets the dolby_vision_mode of this StatisticsPerStream.
- Returns
The dolby_vision_mode of this StatisticsPerStream.
- Return type
- property dolby_vision_multiplicator
Gets the dolby_vision_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for Dolby Vision streams
- Returns
The dolby_vision_multiplicator of this StatisticsPerStream.
- Return type
float
- property dolby_vision_to_hdr
Gets the dolby_vision_to_hdr of this StatisticsPerStream.
Indicates if the conversion from Dolby Vision to HDR was triggered.
- Returns
The dolby_vision_to_hdr of this StatisticsPerStream.
- Return type
bool
- property dolby_vision_to_hdr_multiplicator
Gets the dolby_vision_to_hdr_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for streams using the conversion from Dolby Vision to HDR.
- Returns
The dolby_vision_to_hdr_multiplicator of this StatisticsPerStream.
- Return type
float
- property dolby_vision_to_sdr
Gets the dolby_vision_to_sdr of this StatisticsPerStream.
Indicates if the conversion from Dolby Vision to SDR was triggered.
- Returns
The dolby_vision_to_sdr of this StatisticsPerStream.
- Return type
bool
- property dolby_vision_to_sdr_multiplicator
Gets the dolby_vision_to_sdr_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for streams using the conversion from Dolby Vision to SDR.
- Returns
The dolby_vision_to_sdr_multiplicator of this StatisticsPerStream.
- Return type
float
- property encoded_bytes
Gets the encoded_bytes of this StatisticsPerStream.
Encoded bytes. (required)
- Returns
The encoded_bytes of this StatisticsPerStream.
- Return type
int
- property encoded_seconds
Gets the encoded_seconds of this StatisticsPerStream.
Length of the stream. (required)
- Returns
The encoded_seconds of this StatisticsPerStream.
- Return type
float
- property encoding_mode
Gets the encoding_mode of this StatisticsPerStream.
- Returns
The encoding_mode of this StatisticsPerStream.
- Return type
- property encoding_mode_multiplicator
Gets the encoding_mode_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for the given encodingMode
- Returns
The encoding_mode_multiplicator of this StatisticsPerStream.
- Return type
float
- property enhanced_deinterlace
Gets the enhanced_deinterlace of this StatisticsPerStream.
Indicates if an enhanced interlace filter was used.
- Returns
The enhanced_deinterlace of this StatisticsPerStream.
- Return type
bool
- property enhanced_deinterlace_multiplicator
Gets the enhanced_deinterlace_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for streams using an enhanced Deinterlace Filter.
- Returns
The enhanced_deinterlace_multiplicator of this StatisticsPerStream.
- Return type
float
- property hdr_hlg_to_sdr
Gets the hdr_hlg_to_sdr of this StatisticsPerStream.
Indicates if the conversion from HDR10/HLG to SDR was triggered.
- Returns
The hdr_hlg_to_sdr of this StatisticsPerStream.
- Return type
bool
- property hdr_hlg_to_sdr_multiplicator
Gets the hdr_hlg_to_sdr_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for streams using the conversion from HDR10/HLG to SDR.
- Returns
The hdr_hlg_to_sdr_multiplicator of this StatisticsPerStream.
- Return type
float
- property height
Gets the height of this StatisticsPerStream.
Video height, only if video stream
- Returns
The height of this StatisticsPerStream.
- Return type
int
- property input_factor
Gets the input_factor of this StatisticsPerStream.
- Returns
The input_factor of this StatisticsPerStream.
- Return type
- property live
Gets the live of this StatisticsPerStream.
Indicates if the stream was part of a live encoding.
- Returns
The live of this StatisticsPerStream.
- Return type
bool
- property live_multiplicator
Gets the live_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for live streams.
- Returns
The live_multiplicator of this StatisticsPerStream.
- Return type
float
- property multiplicator
Gets the multiplicator of this StatisticsPerStream.
Multiplier for the encoded minutes. Depends on muxing type. (required)
- Returns
The multiplicator of this StatisticsPerStream.
- Return type
float
- property nex_guard_ab_watermarking_multiplicator
Gets the nex_guard_ab_watermarking_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for streams using a NexGuard A/B Watermarking.
- Returns
The nex_guard_ab_watermarking_multiplicator of this StatisticsPerStream.
- Return type
float
- property nex_guard_ab_watermarking_type
Gets the nex_guard_ab_watermarking_type of this StatisticsPerStream.
- Returns
The nex_guard_ab_watermarking_type of this StatisticsPerStream.
- Return type
- property openapi_types
- property per_title_multiplicator
Gets the per_title_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for per-title
- Returns
The per_title_multiplicator of this StatisticsPerStream.
- Return type
float
- property per_title_result_stream
Gets the per_title_result_stream of this StatisticsPerStream.
- Returns
The per_title_result_stream of this StatisticsPerStream.
- Return type
- property pixel_format_bit_depth
Gets the pixel_format_bit_depth of this StatisticsPerStream.
- Returns
The pixel_format_bit_depth of this StatisticsPerStream.
- Return type
- property pixel_format_multiplicator
Gets the pixel_format_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for the pixel format bit depth
- Returns
The pixel_format_multiplicator of this StatisticsPerStream.
- Return type
float
- property preset
Gets the preset of this StatisticsPerStream.
Name of the preset configuration used for the codec configuration or “CUSTOM” if any preset values were overridden
- Returns
The preset of this StatisticsPerStream.
- Return type
string_types
- property preset_multiplicator
Gets the preset_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for the used codec configuration preset.
- Returns
The preset_multiplicator of this StatisticsPerStream.
- Return type
float
- property psnr_mode
Gets the psnr_mode of this StatisticsPerStream.
- Returns
The psnr_mode of this StatisticsPerStream.
- Return type
- property psnr_multiplicator
Gets the psnr_multiplicator of this StatisticsPerStream.
The output minutes multiplicator for psnr streams
- Returns
The psnr_multiplicator of this StatisticsPerStream.
- Return type
float
- property rate
Gets the rate of this StatisticsPerStream.
If it’ a video stream this value is the FPS, for audio it’s the sample rate. (required)
- Returns
The rate of this StatisticsPerStream.
- Return type
float
- property resolution
Gets the resolution of this StatisticsPerStream.
- Returns
The resolution of this StatisticsPerStream.
- Return type
- property stream_id
Gets the stream_id of this StatisticsPerStream.
ID of the stream (required)
- Returns
The stream_id of this StatisticsPerStream.
- Return type
string_types
- property width
Gets the width of this StatisticsPerStream.
Video width, only if video stream
- Returns
The width of this StatisticsPerStream.
- Return type
int
bitmovin_api_sdk.models.statistics_per_title_stream module
bitmovin_api_sdk.models.statistics_resolution module
bitmovin_api_sdk.models.status module
bitmovin_api_sdk.models.stream module
- class bitmovin_api_sdk.models.stream.Stream(**kwargs)[source]
Bases:
BitmovinResource- property applied_settings
Gets the applied_settings of this Stream.
Contains stream properties which may not have been defined in the configuration
- Returns
The applied_settings of this Stream.
- Return type
- property attribute_map
- property codec_config_id
Gets the codec_config_id of this Stream.
Id of the codec configuration (required)
- Returns
The codec_config_id of this Stream.
- Return type
string_types
- property conditions
Gets the conditions of this Stream.
Defines a condition that is evaluated against the input of the Stream. If the condition is not fulfilled, the Stream will be ignored during the encoding process. The ‘streamConditionMode’ of a Muxing allows to control how ignored Streams affect the Muxing. When retrieving the resource after the analysis step of the encoding has finished, ‘ignoredBy’ will indicate if and why it has been ignored. See [Stream Conditions](https://bitmovin.com/docs/encoding/articles/stream-conditions) for more information
- Returns
The conditions of this Stream.
- Return type
- property create_quality_meta_data
Gets the create_quality_meta_data of this Stream.
Set true to create quality metadata for this stream
- Returns
The create_quality_meta_data of this Stream.
- Return type
bool
- property decoding_error_mode
Gets the decoding_error_mode of this Stream.
Determines how to react to errors during decoding
- Returns
The decoding_error_mode of this Stream.
- Return type
- property ignored_by
Gets the ignored_by of this Stream.
This read-only property is set during the analysis step of the encoding. If it contains items, the Stream has been ignored during the encoding process due to its ‘conditions’
- Returns
The ignored_by of this Stream.
- Return type
list[Ignoring]
- property input_streams
Gets the input_streams of this Stream.
Determines the input source(s) for the stream. All video streams of an encoding need to have identical input configurations (required)
- Returns
The input_streams of this Stream.
- Return type
list[StreamInput]
- property metadata
Gets the metadata of this Stream.
- Returns
The metadata of this Stream.
- Return type
- property mode
Gets the mode of this Stream.
Mode of the stream
- Returns
The mode of this Stream.
- Return type
- property openapi_types
- property outputs
Gets the outputs of this Stream.
- Returns
The outputs of this Stream.
- Return type
list[EncodingOutput]
- property per_title_settings
Gets the per_title_settings of this Stream.
Settings to configure Per-Title on stream level
- Returns
The per_title_settings of this Stream.
- Return type
- property segments_encoded
Gets the segments_encoded of this Stream.
Number of encoded segments. Available after encoding finishes.
- Returns
The segments_encoded of this Stream.
- Return type
int
- property selected_encoding_mode
Gets the selected_encoding_mode of this Stream.
The encoding mode that was used for this stream. This is derived from encodingMode, which can be specified in the codec configuration or in the encoding start request. Note that all streams of an encoding need to use the same encoding mode. This will therefore always match selectedEncodingMode of the related Encoding resource. Especially useful when encodingMode was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).
- Returns
The selected_encoding_mode of this Stream.
- Return type
bitmovin_api_sdk.models.stream_caption_output_format module
bitmovin_api_sdk.models.stream_conditions_mode module
bitmovin_api_sdk.models.stream_filter module
- class bitmovin_api_sdk.models.stream_filter.StreamFilter(**kwargs)[source]
Bases:
object- property attribute_map
- property id
Gets the id of this StreamFilter.
The id of the filter that should be used in the stream (required)
- Returns
The id of this StreamFilter.
- Return type
string_types
- property openapi_types
- property position
Gets the position of this StreamFilter.
Defines the order in which filters are applied. Filters are applied in ascending order. (required)
- Returns
The position of this StreamFilter.
- Return type
int
bitmovin_api_sdk.models.stream_filter_list module
- class bitmovin_api_sdk.models.stream_filter_list.StreamFilterList(**kwargs)[source]
Bases:
object- property attribute_map
- property filters
Gets the filters of this StreamFilterList.
List of stream filters (required)
- Returns
The filters of this StreamFilterList.
- Return type
list[StreamFilter]
- property openapi_types
bitmovin_api_sdk.models.stream_info module
- class bitmovin_api_sdk.models.stream_info.StreamInfo(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property audio
Gets the audio of this StreamInfo.
It MUST match the value of the GROUP-ID attribute of an Audio EXT-X-MEDIA tag elsewhere in the Master Playlist. Either this or audioGroups must be set.
- Returns
The audio of this StreamInfo.
- Return type
string_types
- property audio_groups
Gets the audio_groups of this StreamInfo.
HLS Audio Group Configuration. You will want to use this configuration property in case you specify conditions on audio streams. The first matching audio group will be used for the specific variant stream. Either this or audio must be set.
- Returns
The audio_groups of this StreamInfo.
- Return type
- property closed_captions
Gets the closed_captions of this StreamInfo.
If the value is not ‘NONE’, it MUST match the value of the GROUP-ID attribute of a Closed Captions EXT-X-MEDIA tag elsewhere in the Playlist (required)
- Returns
The closed_captions of this StreamInfo.
- Return type
string_types
- property drm_id
Gets the drm_id of this StreamInfo.
Id of the DRM.
- Returns
The drm_id of this StreamInfo.
- Return type
string_types
- property encoding_id
Gets the encoding_id of this StreamInfo.
Id of the encoding. (required)
- Returns
The encoding_id of this StreamInfo.
- Return type
string_types
- property end_segment_number
Gets the end_segment_number of this StreamInfo.
Number of the last segment. Default is the last one that was encoded.
- Returns
The end_segment_number of this StreamInfo.
- Return type
int
- property force_frame_rate_attribute
Gets the force_frame_rate_attribute of this StreamInfo.
Force the addition of the frame rate attribute to all stream infos.
- Returns
The force_frame_rate_attribute of this StreamInfo.
- Return type
bool
- property force_video_range_attribute
Gets the force_video_range_attribute of this StreamInfo.
Force the addition of the video-range attribute to all stream infos.
- Returns
The force_video_range_attribute of this StreamInfo.
- Return type
bool
- property muxing_id
Gets the muxing_id of this StreamInfo.
Id of the muxing. (required)
- Returns
The muxing_id of this StreamInfo.
- Return type
string_types
- property openapi_types
- property segment_path
Gets the segment_path of this StreamInfo.
Path to segments. (required)
- Returns
The segment_path of this StreamInfo.
- Return type
string_types
- property start_segment_number
Gets the start_segment_number of this StreamInfo.
Number of the first segment. Default is 0.
- Returns
The start_segment_number of this StreamInfo.
- Return type
int
- property stream_id
Gets the stream_id of this StreamInfo.
Id of the stream. (required)
- Returns
The stream_id of this StreamInfo.
- Return type
string_types
- property subtitles
Gets the subtitles of this StreamInfo.
It MUST match the value of the GROUP-ID attribute of a Subtitles EXT-X-MEDIA tag elsewhere in the Master Playlist
- Returns
The subtitles of this StreamInfo.
- Return type
string_types
- property uri
Gets the uri of this StreamInfo.
The URI of the playlist file. (required)
- Returns
The uri of this StreamInfo.
- Return type
string_types
- property video
Gets the video of this StreamInfo.
It MUST match the value of the GROUP-ID attribute of a Video EXT-X-MEDIA tag elsewhere in the Master Playlist
- Returns
The video of this StreamInfo.
- Return type
string_types
bitmovin_api_sdk.models.stream_infos module
- class bitmovin_api_sdk.models.stream_infos.StreamInfos(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property stream_infos
Gets the stream_infos of this StreamInfos.
Details about billable minutes for each resolution category
- Returns
The stream_infos of this StreamInfos.
- Return type
list[StreamInfosDetails]
- property time
Gets the time of this StreamInfos.
Timestamp of the event, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)
- Returns
The time of this StreamInfos.
- Return type
datetime
bitmovin_api_sdk.models.stream_infos_details module
- class bitmovin_api_sdk.models.stream_infos_details.StreamInfosDetails(**kwargs)[source]
Bases:
object- property attribute_map
- property bytes_backup_per_second_avg
Gets the bytes_backup_per_second_avg of this StreamInfosDetails.
The average amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)
- Returns
The bytes_backup_per_second_avg of this StreamInfosDetails.
- Return type
float
- property bytes_backup_per_second_max
Gets the bytes_backup_per_second_max of this StreamInfosDetails.
The maximum amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)
- Returns
The bytes_backup_per_second_max of this StreamInfosDetails.
- Return type
float
- property bytes_backup_per_second_min
Gets the bytes_backup_per_second_min of this StreamInfosDetails.
The minimum amount of backup bytes used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)
- Returns
The bytes_backup_per_second_min of this StreamInfosDetails.
- Return type
float
- property bytes_read_per_second_avg
Gets the bytes_read_per_second_avg of this StreamInfosDetails.
The average bytes read per second within the last minute (required)
- Returns
The bytes_read_per_second_avg of this StreamInfosDetails.
- Return type
float
- property bytes_read_per_second_max
Gets the bytes_read_per_second_max of this StreamInfosDetails.
The maximum bytes read per second within the last minute (required)
- Returns
The bytes_read_per_second_max of this StreamInfosDetails.
- Return type
float
- property bytes_read_per_second_min
Gets the bytes_read_per_second_min of this StreamInfosDetails.
The minimum bytes read per second within the last minute (required)
- Returns
The bytes_read_per_second_min of this StreamInfosDetails.
- Return type
float
- property codec
Gets the codec of this StreamInfosDetails.
The codec of the input stream (required)
- Returns
The codec of this StreamInfosDetails.
- Return type
- property height
Gets the height of this StreamInfosDetails.
The height of the stream, if it is a video stream
- Returns
The height of this StreamInfosDetails.
- Return type
int
- property id
Gets the id of this StreamInfosDetails.
The id of the stream (required)
- Returns
The id of this StreamInfosDetails.
- Return type
string_types
- property media_type
Gets the media_type of this StreamInfosDetails.
The media type of the stream (required)
- Returns
The media_type of this StreamInfosDetails.
- Return type
- property openapi_types
- property rate
Gets the rate of this StreamInfosDetails.
The rate (sample rate / fps) of the stream (required)
- Returns
The rate of this StreamInfosDetails.
- Return type
float
- property samples_backup_per_second_avg
Gets the samples_backup_per_second_avg of this StreamInfosDetails.
The average amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)
- Returns
The samples_backup_per_second_avg of this StreamInfosDetails.
- Return type
float
- property samples_backup_per_second_max
Gets the samples_backup_per_second_max of this StreamInfosDetails.
The maximum amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)
- Returns
The samples_backup_per_second_max of this StreamInfosDetails.
- Return type
float
- property samples_backup_per_second_min
Gets the samples_backup_per_second_min of this StreamInfosDetails.
The minimum amount of backup samples used per second within the last minute. This will be written when no live stream is ingested. The last picture will be repeated with silent audio. (required)
- Returns
The samples_backup_per_second_min of this StreamInfosDetails.
- Return type
float
- property samples_read_per_second_avg
Gets the samples_read_per_second_avg of this StreamInfosDetails.
The average samples read per second within the last minute (required)
- Returns
The samples_read_per_second_avg of this StreamInfosDetails.
- Return type
float
- property samples_read_per_second_max
Gets the samples_read_per_second_max of this StreamInfosDetails.
The maximum samples read per second within the last minute (required)
- Returns
The samples_read_per_second_max of this StreamInfosDetails.
- Return type
float
- property samples_read_per_second_min
Gets the samples_read_per_second_min of this StreamInfosDetails.
The minimum samples read per second within the last minute (required)
- Returns
The samples_read_per_second_min of this StreamInfosDetails.
- Return type
float
- property width
Gets the width of this StreamInfosDetails.
The width of the stream, if it is a video stream
- Returns
The width of this StreamInfosDetails.
- Return type
int
bitmovin_api_sdk.models.stream_input module
- class bitmovin_api_sdk.models.stream_input.StreamInput(**kwargs)[source]
Bases:
object- property analysis_details
Gets the analysis_details of this StreamInput.
Input analysis details This property is populated after the encoding has finished
- Returns
The analysis_details of this StreamInput.
- Return type
- property attribute_map
- property input_id
Gets the input_id of this StreamInput.
ID of an Input resource defining the input storage. Required if ‘inputStreamId’ is not set.
- Returns
The input_id of this StreamInput.
- Return type
string_types
- property input_path
Gets the input_path of this StreamInput.
Path to an input media file. Required if ‘inputStreamId’ is not set.
- Returns
The input_path of this StreamInput.
- Return type
string_types
- property input_stream_id
Gets the input_stream_id of this StreamInput.
Set this property instead of all others to reference an InputStream resource (e.g. an Ingest-, Trimming- or ConcatenationInputStream)
- Returns
The input_stream_id of this StreamInput.
- Return type
string_types
- property openapi_types
- property position
Gets the position of this StreamInput.
Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode ‘AUTO’, defaults to 0 for any other selectionMode.
- Returns
The position of this StreamInput.
- Return type
int
- property selection_mode
Gets the selection_mode of this StreamInput.
Specifies the strategy for selecting a stream from the input file. Must not be set when ‘inputStreamId’ is set.
- Returns
The selection_mode of this StreamInput.
- Return type
bitmovin_api_sdk.models.stream_key module
- class bitmovin_api_sdk.models.stream_key.StreamKey(**kwargs)[source]
Bases:
BitmovinResource- property assigned_encoding_id
Gets the assigned_encoding_id of this StreamKey.
ID of the encoding that is assigned to this stream key. Not set if status is UNASSIGNED
- Returns
The assigned_encoding_id of this StreamKey.
- Return type
string_types
- property assigned_ingest_point_id
Gets the assigned_ingest_point_id of this StreamKey.
ID of the ingest point that is assigned to this stream key. Not set if status is UNASSIGNED
- Returns
The assigned_ingest_point_id of this StreamKey.
- Return type
string_types
- property attribute_map
- property openapi_types
- property status
Gets the status of this StreamKey.
Status of the stream key
- Returns
The status of this StreamKey.
- Return type
- property type
Gets the type of this StreamKey.
Type of the stream key
- Returns
The type of this StreamKey.
- Return type
- property value
Gets the value of this StreamKey.
Stream key used for live streaming. This stream key is reserved and can be re-used with different live encodings. If this value is not provided, a unique random stream key will be generated. Important: This value has to be globally unique. If it is set manually, be sure to use a secure value. If the stream key value is guessed by others your live encoding can be compromised.
- Returns
The value of this StreamKey.
- Return type
string_types
bitmovin_api_sdk.models.stream_key_configuration module
- class bitmovin_api_sdk.models.stream_key_configuration.StreamKeyConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property stream_key_id
Gets the stream_key_id of this StreamKeyConfiguration.
Id of the previously generated stream key. Only needed when the type is ASSIGN.
- Returns
The stream_key_id of this StreamKeyConfiguration.
- Return type
string_types
- property type
Gets the type of this StreamKeyConfiguration.
- Returns
The type of this StreamKeyConfiguration.
- Return type
bitmovin_api_sdk.models.stream_key_configuration_type module
bitmovin_api_sdk.models.stream_key_status module
bitmovin_api_sdk.models.stream_key_type module
bitmovin_api_sdk.models.stream_keys_unassign_action module
- class bitmovin_api_sdk.models.stream_keys_unassign_action.StreamKeysUnassignAction(**kwargs)[source]
Bases:
object- property attribute_map
- property encoding_id
Gets the encoding_id of this StreamKeysUnassignAction.
Encoding ID for which stream keys should be unassigned
- Returns
The encoding_id of this StreamKeysUnassignAction.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.stream_metadata module
- class bitmovin_api_sdk.models.stream_metadata.StreamMetadata(**kwargs)[source]
Bases:
object- property attribute_map
- property language
Gets the language of this StreamMetadata.
Language of the media contained in the stream. If the value is not set, then no metadata tag is set for the media stream.
- Returns
The language of this StreamMetadata.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.stream_mode module
- class bitmovin_api_sdk.models.stream_mode.StreamMode(value)[source]
Bases:
EnumAn enumeration.
- PER_TITLE_RESULT = 'PER_TITLE_RESULT'
- PER_TITLE_TEMPLATE = 'PER_TITLE_TEMPLATE'
- PER_TITLE_TEMPLATE_FIXED_RESOLUTION = 'PER_TITLE_TEMPLATE_FIXED_RESOLUTION'
- PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE = 'PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE'
- STANDARD = 'STANDARD'
bitmovin_api_sdk.models.stream_per_title_fixed_resolution_and_bitrate_settings module
- class bitmovin_api_sdk.models.stream_per_title_fixed_resolution_and_bitrate_settings.StreamPerTitleFixedResolutionAndBitrateSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property bitrate_selection_mode
Gets the bitrate_selection_mode of this StreamPerTitleFixedResolutionAndBitrateSettings.
Bitrate selection mode
- Returns
The bitrate_selection_mode of this StreamPerTitleFixedResolutionAndBitrateSettings.
- Return type
- property high_complexity_boundary_for_max_bitrate
Gets the high_complexity_boundary_for_max_bitrate of this StreamPerTitleFixedResolutionAndBitrateSettings.
High complexity boundary for max bitrate
- Returns
The high_complexity_boundary_for_max_bitrate of this StreamPerTitleFixedResolutionAndBitrateSettings.
- Return type
int
- property low_complexity_boundary_for_max_bitrate
Gets the low_complexity_boundary_for_max_bitrate of this StreamPerTitleFixedResolutionAndBitrateSettings.
Low complexity boundary for max bitrate
- Returns
The low_complexity_boundary_for_max_bitrate of this StreamPerTitleFixedResolutionAndBitrateSettings.
- Return type
int
- property max_bitrate
Gets the max_bitrate of this StreamPerTitleFixedResolutionAndBitrateSettings.
The maximum bitrate that will be used for that template.
- Returns
The max_bitrate of this StreamPerTitleFixedResolutionAndBitrateSettings.
- Return type
int
- property min_bitrate
Gets the min_bitrate of this StreamPerTitleFixedResolutionAndBitrateSettings.
The minimum bitrate that will be used for that template.
- Returns
The min_bitrate of this StreamPerTitleFixedResolutionAndBitrateSettings.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.stream_per_title_settings module
- class bitmovin_api_sdk.models.stream_per_title_settings.StreamPerTitleSettings(**kwargs)[source]
Bases:
object- property attribute_map
- property fixed_resolution_and_bitrate_settings
Gets the fixed_resolution_and_bitrate_settings of this StreamPerTitleSettings.
Settings for PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE mode
- Returns
The fixed_resolution_and_bitrate_settings of this StreamPerTitleSettings.
- Return type
- property openapi_types
bitmovin_api_sdk.models.stream_selection_mode module
bitmovin_api_sdk.models.streams_ad_config_ad module
- class bitmovin_api_sdk.models.streams_ad_config_ad.StreamsAdConfigAd(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property position
Gets the position of this StreamsAdConfigAd.
- Returns
The position of this StreamsAdConfigAd.
- Return type
string_types
- property type
Gets the type of this StreamsAdConfigAd.
- Returns
The type of this StreamsAdConfigAd.
- Return type
string_types
- property url
Gets the url of this StreamsAdConfigAd.
- Returns
The url of this StreamsAdConfigAd.
- Return type
string_types
bitmovin_api_sdk.models.streams_ad_config_response module
- class bitmovin_api_sdk.models.streams_ad_config_response.StreamsAdConfigResponse(**kwargs)[source]
Bases:
object- property ads
Gets the ads of this StreamsAdConfigResponse.
- Returns
The ads of this StreamsAdConfigResponse.
- Return type
list[StreamsAdConfigAd]
- property attribute_map
- property id
Gets the id of this StreamsAdConfigResponse.
The identifier of the streams ad config
- Returns
The id of this StreamsAdConfigResponse.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.streams_domain_restriction_create_request module
- class bitmovin_api_sdk.models.streams_domain_restriction_create_request.StreamsDomainRestrictionCreateRequest(**kwargs)[source]
Bases:
object- property allow_no_referer
Gets the allow_no_referer of this StreamsDomainRestrictionCreateRequest.
Controls if requests to domain restricted streams without referer header should be allowed or denied
- Returns
The allow_no_referer of this StreamsDomainRestrictionCreateRequest.
- Return type
bool
Gets the allow_share of this StreamsDomainRestrictionCreateRequest.
Controls if Stream is accessible via sharing URL or not
- Returns
The allow_share of this StreamsDomainRestrictionCreateRequest.
- Return type
bool
- property allowed_domains
Gets the allowed_domains of this StreamsDomainRestrictionCreateRequest.
The list of allowed domains (required)
- Returns
The allowed_domains of this StreamsDomainRestrictionCreateRequest.
- Return type
list[string_types]
- property attribute_map
- property openapi_types
bitmovin_api_sdk.models.streams_domain_restriction_response module
- class bitmovin_api_sdk.models.streams_domain_restriction_response.StreamsDomainRestrictionResponse(**kwargs)[source]
Bases:
object- property allow_no_referer
Gets the allow_no_referer of this StreamsDomainRestrictionResponse.
Controls if requests to domain restricted streams without referer header should be allowed or denied
- Returns
The allow_no_referer of this StreamsDomainRestrictionResponse.
- Return type
bool
Gets the allow_share of this StreamsDomainRestrictionResponse.
Controls if Stream is accessible via sharing URL or not
- Returns
The allow_share of this StreamsDomainRestrictionResponse.
- Return type
bool
- property allowed_domains
Gets the allowed_domains of this StreamsDomainRestrictionResponse.
The list of allowed domains
- Returns
The allowed_domains of this StreamsDomainRestrictionResponse.
- Return type
list[string_types]
- property attribute_map
- property id
Gets the id of this StreamsDomainRestrictionResponse.
The identifier of the streams domain restriction entity
- Returns
The id of this StreamsDomainRestrictionResponse.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.streams_domain_restriction_update_request module
- class bitmovin_api_sdk.models.streams_domain_restriction_update_request.StreamsDomainRestrictionUpdateRequest(**kwargs)[source]
Bases:
object- property allow_no_referer
Gets the allow_no_referer of this StreamsDomainRestrictionUpdateRequest.
Controls if requests to domain restricted streams without referer header should be allowed or denied
- Returns
The allow_no_referer of this StreamsDomainRestrictionUpdateRequest.
- Return type
bool
Gets the allow_share of this StreamsDomainRestrictionUpdateRequest.
Controls if Stream is accessible via sharing URL or not
- Returns
The allow_share of this StreamsDomainRestrictionUpdateRequest.
- Return type
bool
- property allowed_domains
Gets the allowed_domains of this StreamsDomainRestrictionUpdateRequest.
The list of allowed domains
- Returns
The allowed_domains of this StreamsDomainRestrictionUpdateRequest.
- Return type
list[string_types]
- property attribute_map
- property openapi_types
bitmovin_api_sdk.models.streams_encoding_profile module
bitmovin_api_sdk.models.streams_live_create_request module
- class bitmovin_api_sdk.models.streams_live_create_request.StreamsLiveCreateRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property description
Gets the description of this StreamsLiveCreateRequest.
Description of the stream
- Returns
The description of this StreamsLiveCreateRequest.
- Return type
string_types
- property domain_restriction_id
Gets the domain_restriction_id of this StreamsLiveCreateRequest.
Id of the domain restriction config to use
- Returns
The domain_restriction_id of this StreamsLiveCreateRequest.
- Return type
string_types
- property openapi_types
- property title
Gets the title of this StreamsLiveCreateRequest.
Title of the stream
- Returns
The title of this StreamsLiveCreateRequest.
- Return type
string_types
bitmovin_api_sdk.models.streams_live_life_cycle module
bitmovin_api_sdk.models.streams_live_response module
- class bitmovin_api_sdk.models.streams_live_response.StreamsLiveResponse(**kwargs)[source]
Bases:
StreamsResponse- property ad_config
Gets the ad_config of this StreamsLiveResponse.
- Returns
The ad_config of this StreamsLiveResponse.
- Return type
- property attribute_map
- property domain_restriction
Gets the domain_restriction of this StreamsLiveResponse.
- Returns
The domain_restriction of this StreamsLiveResponse.
- Return type
- property life_cycle
Gets the life_cycle of this StreamsLiveResponse.
The life cycle of the stream
- Returns
The life_cycle of this StreamsLiveResponse.
- Return type
- property openapi_types
- property poster_url
Gets the poster_url of this StreamsLiveResponse.
Poster URL
- Returns
The poster_url of this StreamsLiveResponse.
- Return type
string_types
- property stream_key
Gets the stream_key of this StreamsLiveResponse.
The streamKey of the stream
- Returns
The stream_key of this StreamsLiveResponse.
- Return type
string_types
- property style_config
Gets the style_config of this StreamsLiveResponse.
- Returns
The style_config of this StreamsLiveResponse.
- Return type
- property trimming
Gets the trimming of this StreamsLiveResponse.
Stream trimming information
- Returns
The trimming of this StreamsLiveResponse.
- Return type
bitmovin_api_sdk.models.streams_live_update_request module
- class bitmovin_api_sdk.models.streams_live_update_request.StreamsLiveUpdateRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property description
Gets the description of this StreamsLiveUpdateRequest.
The new description of the stream
- Returns
The description of this StreamsLiveUpdateRequest.
- Return type
string_types
- property domain_restriction_id
Gets the domain_restriction_id of this StreamsLiveUpdateRequest.
Id of the domain restriction config to use
- Returns
The domain_restriction_id of this StreamsLiveUpdateRequest.
- Return type
string_types
- property openapi_types
- property poster_url
Gets the poster_url of this StreamsLiveUpdateRequest.
URL to hosted poster image
- Returns
The poster_url of this StreamsLiveUpdateRequest.
- Return type
string_types
- property title
Gets the title of this StreamsLiveUpdateRequest.
The new title of the stream
- Returns
The title of this StreamsLiveUpdateRequest.
- Return type
string_types
bitmovin_api_sdk.models.streams_public_signing_key module
- class bitmovin_api_sdk.models.streams_public_signing_key.StreamsPublicSigningKey(**kwargs)[source]
Bases:
object- property attribute_map
- property created_at
Gets the created_at of this StreamsPublicSigningKey.
- Returns
The created_at of this StreamsPublicSigningKey.
- Return type
datetime
- property key_id
Gets the key_id of this StreamsPublicSigningKey.
The unique identifier of the key
- Returns
The key_id of this StreamsPublicSigningKey.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.streams_public_signing_key_response module
- class bitmovin_api_sdk.models.streams_public_signing_key_response.StreamsPublicSigningKeyResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property public_keys
Gets the public_keys of this StreamsPublicSigningKeyResponse.
- Returns
The public_keys of this StreamsPublicSigningKeyResponse.
- Return type
list[StreamsPublicSigningKey]
bitmovin_api_sdk.models.streams_response module
- class bitmovin_api_sdk.models.streams_response.StreamsResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property created_at
Gets the created_at of this StreamsResponse.
Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this StreamsResponse.
- Return type
datetime
- property description
Gets the description of this StreamsResponse.
The description of the stream
- Returns
The description of this StreamsResponse.
- Return type
string_types
- discriminator_value_class_map = {'LIVE': 'StreamsLiveResponse', 'VIDEO': 'StreamsVideoResponse'}
- property id
Gets the id of this StreamsResponse.
The identifier of the stream
- Returns
The id of this StreamsResponse.
- Return type
string_types
- property openapi_types
- property title
Gets the title of this StreamsResponse.
The title of the stream
- Returns
The title of this StreamsResponse.
- Return type
string_types
- property type
Gets the type of this StreamsResponse.
Type of the Stream contained in the StreamsResponse
- Returns
The type of this StreamsResponse.
- Return type
bitmovin_api_sdk.models.streams_signing_key_response module
- class bitmovin_api_sdk.models.streams_signing_key_response.StreamsSigningKeyResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property key_id
Gets the key_id of this StreamsSigningKeyResponse.
The unique identifier of the key
- Returns
The key_id of this StreamsSigningKeyResponse.
- Return type
string_types
- property message
Gets the message of this StreamsSigningKeyResponse.
- Returns
The message of this StreamsSigningKeyResponse.
- Return type
string_types
- property openapi_types
- property private_key
Gets the private_key of this StreamsSigningKeyResponse.
base64-encoded PEM file of the private key
- Returns
The private_key of this StreamsSigningKeyResponse.
- Return type
string_types
bitmovin_api_sdk.models.streams_style_config_player_style module
- class bitmovin_api_sdk.models.streams_style_config_player_style.StreamsStyleConfigPlayerStyle(**kwargs)[source]
Bases:
object- property attribute_map
- property background_color
Gets the background_color of this StreamsStyleConfigPlayerStyle.
Background color
- Returns
The background_color of this StreamsStyleConfigPlayerStyle.
- Return type
string_types
- property openapi_types
- property playback_marker_bg_color
Gets the playback_marker_bg_color of this StreamsStyleConfigPlayerStyle.
Playback marker background color
- Returns
The playback_marker_bg_color of this StreamsStyleConfigPlayerStyle.
- Return type
string_types
- property playback_marker_border_color
Gets the playback_marker_border_color of this StreamsStyleConfigPlayerStyle.
Playback marker border color
- Returns
The playback_marker_border_color of this StreamsStyleConfigPlayerStyle.
- Return type
string_types
- property playback_track_bg_color
Gets the playback_track_bg_color of this StreamsStyleConfigPlayerStyle.
Playback track background color
- Returns
The playback_track_bg_color of this StreamsStyleConfigPlayerStyle.
- Return type
string_types
- property playback_track_buffered_color
Gets the playback_track_buffered_color of this StreamsStyleConfigPlayerStyle.
Playback track buffered color
- Returns
The playback_track_buffered_color of this StreamsStyleConfigPlayerStyle.
- Return type
string_types
- property playback_track_played_color
Gets the playback_track_played_color of this StreamsStyleConfigPlayerStyle.
Playback track played color
- Returns
The playback_track_played_color of this StreamsStyleConfigPlayerStyle.
- Return type
string_types
- property text_color
Gets the text_color of this StreamsStyleConfigPlayerStyle.
Text color
- Returns
The text_color of this StreamsStyleConfigPlayerStyle.
- Return type
string_types
bitmovin_api_sdk.models.streams_style_config_response module
- class bitmovin_api_sdk.models.streams_style_config_response.StreamsStyleConfigResponse(**kwargs)[source]
Bases:
object- property attribute_map
- property id
Gets the id of this StreamsStyleConfigResponse.
The identifier of the style config
- Returns
The id of this StreamsStyleConfigResponse.
- Return type
string_types
- property openapi_types
- property org_id
Gets the org_id of this StreamsStyleConfigResponse.
UUID of the associated organization
- Returns
The org_id of this StreamsStyleConfigResponse.
- Return type
string_types
- property player_style
Gets the player_style of this StreamsStyleConfigResponse.
- Returns
The player_style of this StreamsStyleConfigResponse.
- Return type
- property watermark_target_link
Gets the watermark_target_link of this StreamsStyleConfigResponse.
Target link of the watermark image
- Returns
The watermark_target_link of this StreamsStyleConfigResponse.
- Return type
string_types
- property watermark_url
Gets the watermark_url of this StreamsStyleConfigResponse.
URL of the watermark image
- Returns
The watermark_url of this StreamsStyleConfigResponse.
- Return type
string_types
bitmovin_api_sdk.models.streams_trimming_status module
bitmovin_api_sdk.models.streams_type module
bitmovin_api_sdk.models.streams_video_create_request module
- class bitmovin_api_sdk.models.streams_video_create_request.StreamsVideoCreateRequest(**kwargs)[source]
Bases:
object- property asset_url
Gets the asset_url of this StreamsVideoCreateRequest.
The streams input asset URL
- Returns
The asset_url of this StreamsVideoCreateRequest.
- Return type
string_types
- property attribute_map
- property description
Gets the description of this StreamsVideoCreateRequest.
Description of the stream
- Returns
The description of this StreamsVideoCreateRequest.
- Return type
string_types
- property domain_restriction_id
Gets the domain_restriction_id of this StreamsVideoCreateRequest.
Id of the domain restriction config to use
- Returns
The domain_restriction_id of this StreamsVideoCreateRequest.
- Return type
string_types
- property encoding_profile
Gets the encoding_profile of this StreamsVideoCreateRequest.
Profile to be used in encoding
- Returns
The encoding_profile of this StreamsVideoCreateRequest.
- Return type
- property openapi_types
- property signed
Gets the signed of this StreamsVideoCreateRequest.
If set to true the Stream is only accessible via a token
- Returns
The signed of this StreamsVideoCreateRequest.
- Return type
bool
- property title
Gets the title of this StreamsVideoCreateRequest.
Title of the stream
- Returns
The title of this StreamsVideoCreateRequest.
- Return type
string_types
bitmovin_api_sdk.models.streams_video_encoding_status module
bitmovin_api_sdk.models.streams_video_encoding_task module
- class bitmovin_api_sdk.models.streams_video_encoding_task.StreamsVideoEncodingTask(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property quality
Gets the quality of this StreamsVideoEncodingTask.
Quality of the encoding
- Returns
The quality of this StreamsVideoEncodingTask.
- Return type
- property status
Gets the status of this StreamsVideoEncodingTask.
Current state of the encoding
- Returns
The status of this StreamsVideoEncodingTask.
- Return type
bitmovin_api_sdk.models.streams_video_quality module
bitmovin_api_sdk.models.streams_video_response module
- class bitmovin_api_sdk.models.streams_video_response.StreamsVideoResponse(**kwargs)[source]
Bases:
StreamsResponse- property ad_config
Gets the ad_config of this StreamsVideoResponse.
- Returns
The ad_config of this StreamsVideoResponse.
- Return type
- property asset_url
Gets the asset_url of this StreamsVideoResponse.
The asset URL of the stream
- Returns
The asset_url of this StreamsVideoResponse.
- Return type
string_types
- property attribute_map
- property domain_restriction
Gets the domain_restriction of this StreamsVideoResponse.
- Returns
The domain_restriction of this StreamsVideoResponse.
- Return type
- property download_url
Gets the download_url of this StreamsVideoResponse.
Single-file download URL of the unaltered video in the best available quality
- Returns
The download_url of this StreamsVideoResponse.
- Return type
string_types
- property encoding_tasks
Gets the encoding_tasks of this StreamsVideoResponse.
List of encoding status information
- Returns
The encoding_tasks of this StreamsVideoResponse.
- Return type
list[StreamsVideoEncodingTask]
- property openapi_types
- property poster_url
Gets the poster_url of this StreamsVideoResponse.
Poster URL
- Returns
The poster_url of this StreamsVideoResponse.
- Return type
string_types
- property signed
Gets the signed of this StreamsVideoResponse.
True if the stream is signature protected
- Returns
The signed of this StreamsVideoResponse.
- Return type
bool
- property status
Gets the status of this StreamsVideoResponse.
The status of the stream
- Returns
The status of this StreamsVideoResponse.
- Return type
- property style_config
Gets the style_config of this StreamsVideoResponse.
- Returns
The style_config of this StreamsVideoResponse.
- Return type
- property trimming
Gets the trimming of this StreamsVideoResponse.
Stream trimming information
- Returns
The trimming of this StreamsVideoResponse.
- Return type
bitmovin_api_sdk.models.streams_video_status module
bitmovin_api_sdk.models.streams_video_update_request module
- class bitmovin_api_sdk.models.streams_video_update_request.StreamsVideoUpdateRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property description
Gets the description of this StreamsVideoUpdateRequest.
The new description of the stream
- Returns
The description of this StreamsVideoUpdateRequest.
- Return type
string_types
- property domain_restriction_id
Gets the domain_restriction_id of this StreamsVideoUpdateRequest.
Id of the domain restriction config to use
- Returns
The domain_restriction_id of this StreamsVideoUpdateRequest.
- Return type
string_types
- property openapi_types
- property poster_url
Gets the poster_url of this StreamsVideoUpdateRequest.
URL to hosted poster image
- Returns
The poster_url of this StreamsVideoUpdateRequest.
- Return type
string_types
- property status
Gets the status of this StreamsVideoUpdateRequest.
The new status of the stream
- Returns
The status of this StreamsVideoUpdateRequest.
- Return type
- property title
Gets the title of this StreamsVideoUpdateRequest.
The new title of the stream
- Returns
The title of this StreamsVideoUpdateRequest.
- Return type
string_types
bitmovin_api_sdk.models.subtask module
- class bitmovin_api_sdk.models.subtask.Subtask(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property created_at
Gets the created_at of this Subtask.
Timestamp when the subtask was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this Subtask.
- Return type
datetime
- property error_at
Gets the error_at of this Subtask.
Timestamp when the subtask status changed to ‘ERROR’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an ‘ERROR’.
- Returns
The error_at of this Subtask.
- Return type
datetime
- property finished_at
Gets the finished_at of this Subtask.
Timestamp when the subtask status changed to a final state like ‘FINISHED’, ‘ERROR’, ‘CANCELED’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for subtasks which ran prior to the [1.50.0 REST API release](https://bitmovin.com/docs/encoding/changelogs/rest).
- Returns
The finished_at of this Subtask.
- Return type
datetime
- property messages
Gets the messages of this Subtask.
Task specific messages
- Returns
The messages of this Subtask.
- Return type
list[Message]
- property name
Gets the name of this Subtask.
Name of the subtask (required)
- Returns
The name of this Subtask.
- Return type
string_types
- property openapi_types
- property progress
Gets the progress of this Subtask.
Progress in percent
- Returns
The progress of this Subtask.
- Return type
int
- property queued_at
Gets the queued_at of this Subtask.
Timestamp when the subtask status changed to ‘QUEUED’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The queued_at of this Subtask.
- Return type
datetime
- property running_at
Gets the running_at of this Subtask.
Timestamp when the subtask status changed to ‘RUNNING’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The running_at of this Subtask.
- Return type
datetime
- property started_at
Gets the started_at of this Subtask.
Timestamp when the subtask was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The started_at of this Subtask.
- Return type
datetime
- property status
Gets the status of this Subtask.
Current status (required)
- Returns
The status of this Subtask.
- Return type
- property updated_at
Gets the updated_at of this Subtask.
Timestamp when the subtask was last updated, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The updated_at of this Subtask.
- Return type
datetime
bitmovin_api_sdk.models.subtitle_adaptation_set module
- class bitmovin_api_sdk.models.subtitle_adaptation_set.SubtitleAdaptationSet(**kwargs)[source]
Bases:
AdaptationSet- property attribute_map
- property lang
Gets the lang of this SubtitleAdaptationSet.
ISO 639-1 (Alpha-2) code identifying the language of the subtitle adaptation set (required)
- Returns
The lang of this SubtitleAdaptationSet.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.subtitle_configuration module
bitmovin_api_sdk.models.subtitle_stream module
- class bitmovin_api_sdk.models.subtitle_stream.SubtitleStream(**kwargs)[source]
Bases:
MediaStream- property attribute_map
- property hearing_impaired
Gets the hearing_impaired of this SubtitleStream.
Hearing impaired support
- Returns
The hearing_impaired of this SubtitleStream.
- Return type
bool
- property language
Gets the language of this SubtitleStream.
Language of the stream
- Returns
The language of this SubtitleStream.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.subtitles_media_info module
- class bitmovin_api_sdk.models.subtitles_media_info.SubtitlesMediaInfo(**kwargs)[source]
Bases:
StandardMediaInfo- property attribute_map
- property forced
Gets the forced of this SubtitlesMediaInfo.
A value of true indicates that the Rendition contains content which is considered essential to play.
- Returns
The forced of this SubtitlesMediaInfo.
- Return type
bool
- property openapi_types
bitmovin_api_sdk.models.task module
- class bitmovin_api_sdk.models.task.Task(**kwargs)[source]
Bases:
BitmovinResponse- property attribute_map
- property created_at
Gets the created_at of this Task.
Timestamp when the task was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The created_at of this Task.
- Return type
datetime
- property error
Gets the error of this Task.
Additional optional error details
- Returns
The error of this Task.
- Return type
- property error_at
Gets the error_at of this Task.
Timestamp when the subtask status changed to ‘ERROR’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an ‘ERROR’.
- Returns
The error_at of this Task.
- Return type
datetime
- property eta
Gets the eta of this Task.
Estimated ETA in seconds
- Returns
The eta of this Task.
- Return type
float
- property finished_at
Gets the finished_at of this Task.
Timestamp when the subtask status changed to a final state like ‘FINISHED’, ‘ERROR’, ‘CANCELED’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for tasks which ran prior to the [1.50.0 REST API release](https://bitmovin.com/docs/encoding/changelogs/rest).
- Returns
The finished_at of this Task.
- Return type
datetime
- property messages
Gets the messages of this Task.
Task specific messages
- Returns
The messages of this Task.
- Return type
list[Message]
- property openapi_types
- property progress
Gets the progress of this Task.
Progress in percent
- Returns
The progress of this Task.
- Return type
int
- property queued_at
Gets the queued_at of this Task.
Timestamp when the task status changed to “QUEUED”, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The queued_at of this Task.
- Return type
datetime
- property running_at
Gets the running_at of this Task.
Timestamp when the task status changed to “RUNNING”, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The running_at of this Task.
- Return type
datetime
- property status
Gets the status of this Task.
Current status (required)
- Returns
The status of this Task.
- Return type
bitmovin_api_sdk.models.tenant module
bitmovin_api_sdk.models.tenant_group_detail module
- class bitmovin_api_sdk.models.tenant_group_detail.TenantGroupDetail(**kwargs)[source]
Bases:
object- property attribute_map
- property id
Gets the id of this TenantGroupDetail.
Id of Group
- Returns
The id of this TenantGroupDetail.
- Return type
string_types
- property name
Gets the name of this TenantGroupDetail.
Name of Group
- Returns
The name of this TenantGroupDetail.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.tenant_with_groups module
- class bitmovin_api_sdk.models.tenant_with_groups.TenantWithGroups(**kwargs)[source]
Bases:
object- property attribute_map
- property email
Gets the email of this TenantWithGroups.
Email of Tenant (required)
- Returns
The email of this TenantWithGroups.
- Return type
string_types
- property groups
Gets the groups of this TenantWithGroups.
List of all groups of Tenant (required)
- Returns
The groups of this TenantWithGroups.
- Return type
list[TenantGroupDetail]
- property id
Gets the id of this TenantWithGroups.
Id of Tenant (required)
- Returns
The id of this TenantWithGroups.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.text_filter module
- class bitmovin_api_sdk.models.text_filter.TextFilter(**kwargs)[source]
Bases:
Filter- property alpha
Gets the alpha of this TextFilter.
If set, alpha blending for the text is applied. Values are valid between 0.0 and 1.0.
- Returns
The alpha of this TextFilter.
- Return type
float
- property attribute_map
- property border_width
Gets the border_width of this TextFilter.
Width of the border around the text
- Returns
The border_width of this TextFilter.
- Return type
int
- property box
Gets the box of this TextFilter.
If set to true a box is drawn around the text using the background color.
- Returns
The box of this TextFilter.
- Return type
bool
- property box_border_width
Gets the box_border_width of this TextFilter.
The width of the box drawn around the text.
- Returns
The box_border_width of this TextFilter.
- Return type
int
- property box_color
Gets the box_color of this TextFilter.
The background color to be used for drawing the box.
- Returns
The box_color of this TextFilter.
- Return type
string_types
- property fix_bounds
Gets the fix_bounds of this TextFilter.
If set to true, it will fix text coordinates to avoid clipping if necessary
- Returns
The fix_bounds of this TextFilter.
- Return type
bool
- property font
Gets the font of this TextFilter.
- Returns
The font of this TextFilter.
- Return type
- property font_color
Gets the font_color of this TextFilter.
The color to be used to draw the text
- Returns
The font_color of this TextFilter.
- Return type
string_types
- property font_size
Gets the font_size of this TextFilter.
Font size to be used to draw the text
- Returns
The font_size of this TextFilter.
- Return type
int
- property font_size_expression
Gets the font_size_expression of this TextFilter.
An expression for the Font size. Either fontSize or fontSizeExpression can be set at the same time. The following variables are valid: main_h, h, H for input height and main_w, w, W for the input_width
- Returns
The font_size_expression of this TextFilter.
- Return type
string_types
- property line_spacing
Gets the line_spacing of this TextFilter.
Line spacing of the border around the box in pixels
- Returns
The line_spacing of this TextFilter.
- Return type
int
- property openapi_types
- property rate
Gets the rate of this TextFilter.
Video frame rate
- Returns
The rate of this TextFilter.
- Return type
string_types
- property shadow_color
Gets the shadow_color of this TextFilter.
Color of the shadow
- Returns
The shadow_color of this TextFilter.
- Return type
string_types
- property shadow_x
Gets the shadow_x of this TextFilter.
X offset of the shadow
- Returns
The shadow_x of this TextFilter.
- Return type
int
- property shadow_y
Gets the shadow_y of this TextFilter.
Y offset of the shadow
- Returns
The shadow_y of this TextFilter.
- Return type
int
- property text
Gets the text of this TextFilter.
String to be drawn
- Returns
The text of this TextFilter.
- Return type
string_types
- property timecode
Gets the timecode of this TextFilter.
If set, the timecode representation in “hh:mm:ss[:;.]ff” format will be applied. Drop-frame timecodes (containing “;” or “.”) must only be used with video frame rates of 29.97, 30, 59.94 or 60 FPS, according to the SMPTE standard
- Returns
The timecode of this TextFilter.
- Return type
string_types
- property x
Gets the x of this TextFilter.
X position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width (required)
- Returns
The x of this TextFilter.
- Return type
string_types
- property y
Gets the y of this TextFilter.
Y position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width (required)
- Returns
The y of this TextFilter.
- Return type
string_types
bitmovin_api_sdk.models.text_filter_font module
- class bitmovin_api_sdk.models.text_filter_font.TextFilterFont(value)[source]
Bases:
EnumAn enumeration.
- DEJAVUSANS = 'DEJAVUSANS'
- DEJAVUSANSMONO = 'DEJAVUSANSMONO'
- DEJAVUSERIF = 'DEJAVUSERIF'
- ROBOTO = 'ROBOTO'
- ROBOTOBLACK = 'ROBOTOBLACK'
- ROBOTOCONDENSED = 'ROBOTOCONDENSED'
- ROBOTOMONO = 'ROBOTOMONO'
bitmovin_api_sdk.models.text_muxing module
- class bitmovin_api_sdk.models.text_muxing.TextMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property filename
Gets the filename of this TextMuxing.
Name of the output file (required)
- Returns
The filename of this TextMuxing.
- Return type
string_types
- property openapi_types
- property start_offset
Gets the start_offset of this TextMuxing.
Offset of MPEG-TS timestamps in seconds. This only affects streams with [WebVttConfiguration](#/Encoding/PostEncodingConfigurationsSubtitlesWebVtt). If set, the X-TIMESTAMP-MAP will be added as described in the [HLS specification](https://datatracker.ietf.org/doc/html/rfc8216#section-3.5). For example, if set to 10 seconds, X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000 will be added after each WEBVTT header. The default for TextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for startOffset for [TsMuxings](#/Encoding/PostEncodingEncodingsMuxingsTsByEncodingId) and [ProgressiveTsMuxings](#/Encoding/PostEncodingEncodingsMuxingsProgressiveTsByEncodingId) is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same startOffset.
- Returns
The start_offset of this TextMuxing.
- Return type
int
bitmovin_api_sdk.models.thumbnail module
- class bitmovin_api_sdk.models.thumbnail.Thumbnail(**kwargs)[source]
Bases:
BitmovinResource- property aspect_mode
Gets the aspect_mode of this Thumbnail.
Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.
- Returns
The aspect_mode of this Thumbnail.
- Return type
- property attribute_map
- property height
Gets the height of this Thumbnail.
Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.
- Returns
The height of this Thumbnail.
- Return type
int
- property interval
Gets the interval of this Thumbnail.
The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.
- Returns
The interval of this Thumbnail.
- Return type
float
- property openapi_types
- property outputs
Gets the outputs of this Thumbnail.
- Returns
The outputs of this Thumbnail.
- Return type
list[EncodingOutput]
- property pattern
Gets the pattern of this Thumbnail.
Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s). (required)
- Returns
The pattern of this Thumbnail.
- Return type
string_types
- property positions
Gets the positions of this Thumbnail.
Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.
- Returns
The positions of this Thumbnail.
- Return type
list[float]
- property unit
Gets the unit of this Thumbnail.
Unit of the values in the positions array.
- Returns
The unit of this Thumbnail.
- Return type
- property width
Gets the width of this Thumbnail.
Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported
- Returns
The width of this Thumbnail.
- Return type
int
bitmovin_api_sdk.models.thumbnail_aspect_mode module
bitmovin_api_sdk.models.thumbnail_unit module
bitmovin_api_sdk.models.time_based_trimming_input_stream module
- class bitmovin_api_sdk.models.time_based_trimming_input_stream.TimeBasedTrimmingInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property duration
Gets the duration of this TimeBasedTrimmingInputStream.
Defines how many seconds of the input will be encoded. Not defining or setting it to null indicates that the remaining input (considering offset) will be encoded.
- Returns
The duration of this TimeBasedTrimmingInputStream.
- Return type
float
- property input_stream_id
Gets the input_stream_id of this TimeBasedTrimmingInputStream.
The id of the ingest input stream that should be trimmed
- Returns
The input_stream_id of this TimeBasedTrimmingInputStream.
- Return type
string_types
- property offset
Gets the offset of this TimeBasedTrimmingInputStream.
Defines the offset in seconds at which the encoding should start, beginning at 0. The frame indicated by this value will be included in the encoding
- Returns
The offset of this TimeBasedTrimmingInputStream.
- Return type
float
- property openapi_types
bitmovin_api_sdk.models.time_span module
- class bitmovin_api_sdk.models.time_span.TimeSpan(**kwargs)[source]
Bases:
object- property attribute_map
- property from_
Gets the from_ of this TimeSpan.
Start offset of the time frame in milliseconds (required)
- Returns
The from_ of this TimeSpan.
- Return type
int
- property openapi_types
- property to
Gets the to of this TimeSpan.
End offset of the time frame in milliseconds (required)
- Returns
The to of this TimeSpan.
- Return type
int
bitmovin_api_sdk.models.timecode_track_trimming_input_stream module
- class bitmovin_api_sdk.models.timecode_track_trimming_input_stream.TimecodeTrackTrimmingInputStream(**kwargs)[source]
Bases:
InputStream- property attribute_map
- property end_time_code
Gets the end_time_code of this TimecodeTrackTrimmingInputStream.
Defines the timecode, in SMPTE-12M format, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding (required)
- Returns
The end_time_code of this TimecodeTrackTrimmingInputStream.
- Return type
string_types
- property input_stream_id
Gets the input_stream_id of this TimecodeTrackTrimmingInputStream.
The id of the ingest input stream that should be trimmed (required)
- Returns
The input_stream_id of this TimecodeTrackTrimmingInputStream.
- Return type
string_types
- property openapi_types
- property start_time_code
Gets the start_time_code of this TimecodeTrackTrimmingInputStream.
Defines the timecode, in SMPTE-12M format, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding (required)
- Returns
The start_time_code of this TimecodeTrackTrimmingInputStream.
- Return type
string_types
bitmovin_api_sdk.models.transfer_retry module
- class bitmovin_api_sdk.models.transfer_retry.TransferRetry(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property error_at
Gets the error_at of this TransferRetry.
Timestamp when the transfer-retry status changed to ‘ERROR’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The error_at of this TransferRetry.
- Return type
datetime
- property finished_at
Gets the finished_at of this TransferRetry.
Timestamp when the transfer-retry status changed to ‘FINISHED’, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The finished_at of this TransferRetry.
- Return type
datetime
- property openapi_types
- property started_at
Gets the started_at of this TransferRetry.
Timestamp when the transfer-retry was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- Returns
The started_at of this TransferRetry.
- Return type
datetime
- property status
Gets the status of this TransferRetry.
The current status of the transfer-retry.
- Returns
The status of this TransferRetry.
- Return type
bitmovin_api_sdk.models.transfer_version module
bitmovin_api_sdk.models.transform_skip_mode module
bitmovin_api_sdk.models.trimming module
- class bitmovin_api_sdk.models.trimming.Trimming(**kwargs)[source]
Bases:
object- property attribute_map
- property duration
Gets the duration of this Trimming.
Defines how many seconds from the input will be encoded. If not set, the input will be encoded until its end.
- Returns
The duration of this Trimming.
- Return type
float
- property end_pic_timing
Gets the end_pic_timing of this Trimming.
Defines the H264 picture timing of the last frame, that will be included in the encoding. Any defined offset or duration in seconds will be ignored.
- Returns
The end_pic_timing of this Trimming.
- Return type
string_types
- property ignore_duration_if_input_too_short
Gets the ignore_duration_if_input_too_short of this Trimming.
When true, “duration” will be interpreted as a maximum and not cause an error if the input is too short
- Returns
The ignore_duration_if_input_too_short of this Trimming.
- Return type
bool
- property offset
Gets the offset of this Trimming.
Defines the offset in seconds from which the encoding should start, beginning at 0.
- Returns
The offset of this Trimming.
- Return type
float
- property openapi_types
- property start_pic_timing
Gets the start_pic_timing of this Trimming.
Defines the H264 picture timing of the first frame from which the encoding should start. Any defined offset or duration in seconds will be ignored.
- Returns
The start_pic_timing of this Trimming.
- Return type
string_types
bitmovin_api_sdk.models.ts_audio_stream_configuration module
bitmovin_api_sdk.models.ts_muxing module
- class bitmovin_api_sdk.models.ts_muxing.TsMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property configuration
Gets the configuration of this TsMuxing.
Advanced Configuration of the MPEG Transport Stream Parameters
- Returns
The configuration of this TsMuxing.
- Return type
- property openapi_types
- property segment_length
Gets the segment_length of this TsMuxing.
Length of the fragments in seconds
- Returns
The segment_length of this TsMuxing.
- Return type
float
- property segment_naming
Gets the segment_naming of this TsMuxing.
Segment naming policy
- Returns
The segment_naming of this TsMuxing.
- Return type
string_types
- property segment_naming_template
Gets the segment_naming_template of this TsMuxing.
Segment naming policy containing one or both of the following placeholders: - ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - ‘{segment_rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.
- Returns
The segment_naming_template of this TsMuxing.
- Return type
string_types
- property segments_muxed
Gets the segments_muxed of this TsMuxing.
Number of segments which have been encoded
- Returns
The segments_muxed of this TsMuxing.
- Return type
int
- property start_offset
Gets the start_offset of this TsMuxing.
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).
- Returns
The start_offset of this TsMuxing.
- Return type
int
bitmovin_api_sdk.models.ts_muxing_configuration module
- class bitmovin_api_sdk.models.ts_muxing_configuration.TsMuxingConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property audio_streams
Gets the audio_streams of this TsMuxingConfiguration.
- Returns
The audio_streams of this TsMuxingConfiguration.
- Return type
- property openapi_types
- property pcr
Gets the pcr of this TsMuxingConfiguration.
- Returns
The pcr of this TsMuxingConfiguration.
- Return type
- property pmt
Gets the pmt of this TsMuxingConfiguration.
- Returns
The pmt of this TsMuxingConfiguration.
- Return type
- property program_number
Gets the program_number of this TsMuxingConfiguration.
An integer value. Value for program_number field in the MPEG Transport Stream Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.
- Returns
The program_number of this TsMuxingConfiguration.
- Return type
int
- property video_streams
Gets the video_streams of this TsMuxingConfiguration.
- Returns
The video_streams of this TsMuxingConfiguration.
- Return type
bitmovin_api_sdk.models.ts_program_clock_reference_configuration module
- class bitmovin_api_sdk.models.ts_program_clock_reference_configuration.TsProgramClockReferenceConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property interval
Gets the interval of this TsProgramClockReferenceConfiguration.
An integer value. Nominal time between MPEG Transport Stream PCRs in milliseconds.
- Returns
The interval of this TsProgramClockReferenceConfiguration.
- Return type
int
- property openapi_types
- property pid
Gets the pid of this TsProgramClockReferenceConfiguration.
An integer value. Packet Identifier (PID) for the MPEG Transport Stream PCR. This should generally point to the video stream PID. If it is not explicitly set it will point to the video stream PID if exists, otherwise to the audio stream PID.
- Returns
The pid of this TsProgramClockReferenceConfiguration.
- Return type
int
bitmovin_api_sdk.models.ts_program_map_table_configuration module
- class bitmovin_api_sdk.models.ts_program_map_table_configuration.TsProgramMapTableConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property pid
Gets the pid of this TsProgramMapTableConfiguration.
An integer value. Packet Identifier (PID) for the MPEG Transport Stream PMT.
- Returns
The pid of this TsProgramMapTableConfiguration.
- Return type
int
bitmovin_api_sdk.models.ts_stream_configuration module
- class bitmovin_api_sdk.models.ts_stream_configuration.TsStreamConfiguration(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property pid
Gets the pid of this TsStreamConfiguration.
An integer value. MPEG Transport Stream Packet Identifier (PID) for this stream. (required)
- Returns
The pid of this TsStreamConfiguration.
- Return type
int
- property stream_id
Gets the stream_id of this TsStreamConfiguration.
The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing. (required)
- Returns
The stream_id of this TsStreamConfiguration.
- Return type
string_types
bitmovin_api_sdk.models.ts_video_stream_configuration module
bitmovin_api_sdk.models.tu_inter_depth module
bitmovin_api_sdk.models.tu_intra_depth module
bitmovin_api_sdk.models.tweaks module
- class bitmovin_api_sdk.models.tweaks.Tweaks(**kwargs)[source]
Bases:
object- property attribute_map
- property audio_video_sync_mode
Gets the audio_video_sync_mode of this Tweaks.
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.
- Returns
The audio_video_sync_mode of this Tweaks.
- Return type
- property openapi_types
bitmovin_api_sdk.models.unsharp_filter module
- class bitmovin_api_sdk.models.unsharp_filter.UnsharpFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property chroma_effect_strength
Gets the chroma_effect_strength of this UnsharpFilter.
Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5
- Returns
The chroma_effect_strength of this UnsharpFilter.
- Return type
float
- property chroma_matrix_horizontal_size
Gets the chroma_matrix_horizontal_size of this UnsharpFilter.
Must be an odd integer between 3 and 23
- Returns
The chroma_matrix_horizontal_size of this UnsharpFilter.
- Return type
int
- property chroma_matrix_vertical_size
Gets the chroma_matrix_vertical_size of this UnsharpFilter.
Must be an odd integer between 3 and 23
- Returns
The chroma_matrix_vertical_size of this UnsharpFilter.
- Return type
int
- property luma_effect_strength
Gets the luma_effect_strength of this UnsharpFilter.
Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5
- Returns
The luma_effect_strength of this UnsharpFilter.
- Return type
float
- property luma_matrix_horizontal_size
Gets the luma_matrix_horizontal_size of this UnsharpFilter.
Must be an odd integer between 3 and 23
- Returns
The luma_matrix_horizontal_size of this UnsharpFilter.
- Return type
int
- property luma_matrix_vertical_size
Gets the luma_matrix_vertical_size of this UnsharpFilter.
Must be an odd integer between 3 and 23
- Returns
The luma_matrix_vertical_size of this UnsharpFilter.
- Return type
int
- property openapi_types
bitmovin_api_sdk.models.update_organization_request module
- class bitmovin_api_sdk.models.update_organization_request.UpdateOrganizationRequest(**kwargs)[source]
Bases:
object- property attribute_map
- property description
Gets the description of this UpdateOrganizationRequest.
- Returns
The description of this UpdateOrganizationRequest.
- Return type
string_types
- property label_color
Gets the label_color of this UpdateOrganizationRequest.
Hexadecimal color
- Returns
The label_color of this UpdateOrganizationRequest.
- Return type
string_types
- property name
Gets the name of this UpdateOrganizationRequest.
- Returns
The name of this UpdateOrganizationRequest.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.utc_timing module
- class bitmovin_api_sdk.models.utc_timing.UtcTiming(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property scheme_id_uri
Gets the scheme_id_uri of this UtcTiming.
The scheme id to use. Please refer to the DASH standard. (required)
- Returns
The scheme_id_uri of this UtcTiming.
- Return type
string_types
- property value
Gets the value of this UtcTiming.
The server to get the time from (required)
- Returns
The value of this UtcTiming.
- Return type
string_types
bitmovin_api_sdk.models.variant_stream_dropping_mode module
bitmovin_api_sdk.models.vertical_low_pass_filtering_mode module
bitmovin_api_sdk.models.video_adaptation_set module
bitmovin_api_sdk.models.video_configuration module
- class bitmovin_api_sdk.models.video_configuration.VideoConfiguration(**kwargs)[source]
Bases:
CodecConfiguration- property attribute_map
- property bitrate
Gets the bitrate of this VideoConfiguration.
Target bitrate for the encoded video in bps. Either bitrate or crf is required.
- Returns
The bitrate of this VideoConfiguration.
- Return type
int
- property color_config
Gets the color_config of this VideoConfiguration.
- Returns
The color_config of this VideoConfiguration.
- Return type
- property display_aspect_ratio
Gets the display_aspect_ratio of this VideoConfiguration.
Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.
- Returns
The display_aspect_ratio of this VideoConfiguration.
- Return type
- property encoding_mode
Gets the encoding_mode of this VideoConfiguration.
The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.
- Returns
The encoding_mode of this VideoConfiguration.
- Return type
- property height
Gets the height of this VideoConfiguration.
Height of the encoded video in pixels
- Returns
The height of this VideoConfiguration.
- Return type
int
- property openapi_types
- property pixel_format
Gets the pixel_format of this VideoConfiguration.
Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.
- Returns
The pixel_format of this VideoConfiguration.
- Return type
- property rate
Gets the rate of this VideoConfiguration.
Target frame rate of the encoded video. Must be set for live encodings
- Returns
The rate of this VideoConfiguration.
- Return type
float
- property sample_aspect_ratio_denominator
Gets the sample_aspect_ratio_denominator of this VideoConfiguration.
The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.
- Returns
The sample_aspect_ratio_denominator of this VideoConfiguration.
- Return type
int
- property sample_aspect_ratio_numerator
Gets the sample_aspect_ratio_numerator of this VideoConfiguration.
The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.
- Returns
The sample_aspect_ratio_numerator of this VideoConfiguration.
- Return type
int
- property width
Gets the width of this VideoConfiguration.
Width of the encoded video in pixels
- Returns
The width of this VideoConfiguration.
- Return type
int
bitmovin_api_sdk.models.video_format module
bitmovin_api_sdk.models.video_media_info module
bitmovin_api_sdk.models.video_stream module
- class bitmovin_api_sdk.models.video_stream.VideoStream(**kwargs)[source]
Bases:
MediaStream- property attribute_map
- property bitrate
Gets the bitrate of this VideoStream.
Bitrate in bps
- Returns
The bitrate of this VideoStream.
- Return type
string_types
- property fps
Gets the fps of this VideoStream.
Frame rate of the video
- Returns
The fps of this VideoStream.
- Return type
string_types
- property height
Gets the height of this VideoStream.
Height of the video (required)
- Returns
The height of this VideoStream.
- Return type
int
- property openapi_types
- property par
Gets the par of this VideoStream.
Pixel aspect ratio of the video. Default is 1.0
- Returns
The par of this VideoStream.
- Return type
float
- property rate
Gets the rate of this VideoStream.
Bitrate in bps (the same as bitrate, but represented as an integer value)
- Returns
The rate of this VideoStream.
- Return type
int
- property rotation
Gets the rotation of this VideoStream.
Rotation of the video for mobile devices. Default is 0.
- Returns
The rotation of this VideoStream.
- Return type
int
- property width
Gets the width of this VideoStream.
Width of the video (required)
- Returns
The width of this VideoStream.
- Return type
int
bitmovin_api_sdk.models.vorbis_audio_configuration module
- class bitmovin_api_sdk.models.vorbis_audio_configuration.VorbisAudioConfiguration(**kwargs)[source]
Bases:
AudioConfiguration- property attribute_map
- property channel_layout
Gets the channel_layout of this VorbisAudioConfiguration.
Channel layout of the audio codec configuration
- Returns
The channel_layout of this VorbisAudioConfiguration.
- Return type
- property openapi_types
bitmovin_api_sdk.models.vorbis_channel_layout module
- class bitmovin_api_sdk.models.vorbis_channel_layout.VorbisChannelLayout(value)[source]
Bases:
EnumAn enumeration.
- CL_2_1 = '2.1'
- CL_2_2 = '2.2'
- CL_3_1 = '3.1'
- CL_4_0 = '4.0'
- CL_5_1 = '5.1'
- CL_5_1_BACK = '5.1_BACK'
- CL_QUAD = 'QUAD'
- CL_STEREO = 'STEREO'
- CL_SURROUND = 'SURROUND'
- MONO = 'MONO'
- NONE = 'NONE'
bitmovin_api_sdk.models.vp8_arnr_type module
bitmovin_api_sdk.models.vp8_noise_sensitivity module
bitmovin_api_sdk.models.vp8_quality module
bitmovin_api_sdk.models.vp8_video_configuration module
- class bitmovin_api_sdk.models.vp8_video_configuration.Vp8VideoConfiguration(**kwargs)[source]
Bases:
VideoConfiguration- property arnr_max_frames
Gets the arnr_max_frames of this Vp8VideoConfiguration.
altref noise reduction max frame count.
- Returns
The arnr_max_frames of this Vp8VideoConfiguration.
- Return type
int
- property arnr_strength
Gets the arnr_strength of this Vp8VideoConfiguration.
altref noise reduction filter strength.
- Returns
The arnr_strength of this Vp8VideoConfiguration.
- Return type
int
- property arnr_type
Gets the arnr_type of this Vp8VideoConfiguration.
- Returns
The arnr_type of this Vp8VideoConfiguration.
- Return type
- property attribute_map
- property cpu_used
Gets the cpu_used of this Vp8VideoConfiguration.
- Returns
The cpu_used of this Vp8VideoConfiguration.
- Return type
int
- property crf
Gets the crf of this Vp8VideoConfiguration.
Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.
- Returns
The crf of this Vp8VideoConfiguration.
- Return type
int
- property lag_in_frames
Gets the lag_in_frames of this Vp8VideoConfiguration.
Number of frames to look ahead for alternate reference frame selection.
- Returns
The lag_in_frames of this Vp8VideoConfiguration.
- Return type
int
- property max_gop
Gets the max_gop of this Vp8VideoConfiguration.
Maximum GOP length, the maximum distance between I-frames
- Returns
The max_gop of this Vp8VideoConfiguration.
- Return type
int
- property max_intra_rate
Gets the max_intra_rate of this Vp8VideoConfiguration.
Maximum I-frame bitrate (percentage) 0=unlimited
- Returns
The max_intra_rate of this Vp8VideoConfiguration.
- Return type
int
- property max_keyframe_interval
Gets the max_keyframe_interval of this Vp8VideoConfiguration.
Maximum interval in seconds between key frames
- Returns
The max_keyframe_interval of this Vp8VideoConfiguration.
- Return type
float
- property min_gop
Gets the min_gop of this Vp8VideoConfiguration.
Minimum GOP length, the minimum distance between I-frames.
- Returns
The min_gop of this Vp8VideoConfiguration.
- Return type
int
- property min_keyframe_interval
Gets the min_keyframe_interval of this Vp8VideoConfiguration.
Minimum interval in seconds between key frames
- Returns
The min_keyframe_interval of this Vp8VideoConfiguration.
- Return type
float
- property noise_sensitivity
Gets the noise_sensitivity of this Vp8VideoConfiguration.
- Returns
The noise_sensitivity of this Vp8VideoConfiguration.
- Return type
- property openapi_types
- property qp_max
Gets the qp_max of this Vp8VideoConfiguration.
Maximum quantization factor.
- Returns
The qp_max of this Vp8VideoConfiguration.
- Return type
int
- property qp_min
Gets the qp_min of this Vp8VideoConfiguration.
Minimum quantization factor.
- Returns
The qp_min of this Vp8VideoConfiguration.
- Return type
int
- property quality
Gets the quality of this Vp8VideoConfiguration.
- Returns
The quality of this Vp8VideoConfiguration.
- Return type
- property rate_overshoot_pct
Gets the rate_overshoot_pct of this Vp8VideoConfiguration.
Datarate overshoot (max) target (percentage).
- Returns
The rate_overshoot_pct of this Vp8VideoConfiguration.
- Return type
int
- property rate_undershoot_pct
Gets the rate_undershoot_pct of this Vp8VideoConfiguration.
Datarate undershoot (min) target (percentage).
- Returns
The rate_undershoot_pct of this Vp8VideoConfiguration.
- Return type
int
- property sharpness
Gets the sharpness of this Vp8VideoConfiguration.
Loop filter sharpness.
- Returns
The sharpness of this Vp8VideoConfiguration.
- Return type
int
- property static_thresh
Gets the static_thresh of this Vp8VideoConfiguration.
A change threshold on blocks below which they will be skipped by the encoder.
- Returns
The static_thresh of this Vp8VideoConfiguration.
- Return type
int
bitmovin_api_sdk.models.vp9_aq_mode module
bitmovin_api_sdk.models.vp9_arnr_type module
bitmovin_api_sdk.models.vp9_dynamic_range_format module
bitmovin_api_sdk.models.vp9_per_title_configuration module
bitmovin_api_sdk.models.vp9_quality module
bitmovin_api_sdk.models.vp9_video_configuration module
- class bitmovin_api_sdk.models.vp9_video_configuration.Vp9VideoConfiguration(**kwargs)[source]
Bases:
VideoConfiguration- property aq_mode
Gets the aq_mode of this Vp9VideoConfiguration.
- Returns
The aq_mode of this Vp9VideoConfiguration.
- Return type
- property arnr_max_frames
Gets the arnr_max_frames of this Vp9VideoConfiguration.
altref noise reduction max frame count.
- Returns
The arnr_max_frames of this Vp9VideoConfiguration.
- Return type
int
- property arnr_strength
Gets the arnr_strength of this Vp9VideoConfiguration.
altref noise reduction filter strength.
- Returns
The arnr_strength of this Vp9VideoConfiguration.
- Return type
int
- property arnr_type
Gets the arnr_type of this Vp9VideoConfiguration.
- Returns
The arnr_type of this Vp9VideoConfiguration.
- Return type
- property attribute_map
- property auto_level_setup
Gets the auto_level_setup of this Vp9VideoConfiguration.
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 rateOvershootPct, or clientBufferSize properties will disable the automatic calculation.
- Returns
The auto_level_setup of this Vp9VideoConfiguration.
- Return type
- property automatic_alt_ref_frames_enabled
Gets the automatic_alt_ref_frames_enabled of this Vp9VideoConfiguration.
Enable automatic alternate reference frames (2pass only)
- Returns
The automatic_alt_ref_frames_enabled of this Vp9VideoConfiguration.
- Return type
bool
- property bias_pct
Gets the bias_pct of this Vp9VideoConfiguration.
CBR/VBR bias (0=CBR, 100=VBR)
- Returns
The bias_pct of this Vp9VideoConfiguration.
- Return type
int
- property client_buffer_size
Gets the client_buffer_size of this Vp9VideoConfiguration.
Client buffer size (ms)
- Returns
The client_buffer_size of this Vp9VideoConfiguration.
- Return type
int
- property client_initial_buffer_size
Gets the client_initial_buffer_size of this Vp9VideoConfiguration.
Client initial buffer size (ms)
- Returns
The client_initial_buffer_size of this Vp9VideoConfiguration.
- Return type
int
- property cpu_used
Gets the cpu_used of this Vp9VideoConfiguration.
Controls the tradeoff between compression efficiency and encoding speed. Higher values indicate a faster encoding. The minimum value for width * height >= 1280 * 720 is 2. If the value is too low it will be overridden.
- Returns
The cpu_used of this Vp9VideoConfiguration.
- Return type
int
- property crf
Gets the crf of this Vp9VideoConfiguration.
Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.
- Returns
The crf of this Vp9VideoConfiguration.
- Return type
int
- property dynamic_range_format
Gets the dynamic_range_format of this Vp9VideoConfiguration.
Automatically configures the VP9 Video Codec to be compatible with the given SDR/HLG format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.
- Returns
The dynamic_range_format of this Vp9VideoConfiguration.
- Return type
- property error_resiliency_enabled
Gets the error_resiliency_enabled of this Vp9VideoConfiguration.
Enables error resiliency feature
- Returns
The error_resiliency_enabled of this Vp9VideoConfiguration.
- Return type
bool
- property frame_parallel
Gets the frame_parallel of this Vp9VideoConfiguration.
Enable frame parallel decodability features
- Returns
The frame_parallel of this Vp9VideoConfiguration.
- Return type
bool
- property lag_in_frames
Gets the lag_in_frames of this Vp9VideoConfiguration.
Number of frames to look ahead for alternate reference frame selection.
- Returns
The lag_in_frames of this Vp9VideoConfiguration.
- Return type
int
- property lossless
Gets the lossless of this Vp9VideoConfiguration.
Lossless mode
- Returns
The lossless of this Vp9VideoConfiguration.
- Return type
bool
- property max_gop
Gets the max_gop of this Vp9VideoConfiguration.
Maximum GOP length, the maximum distance between I-frames
- Returns
The max_gop of this Vp9VideoConfiguration.
- Return type
int
- property max_intra_rate
Gets the max_intra_rate of this Vp9VideoConfiguration.
Maximum I-frame bitrate (percentage) 0=unlimited
- Returns
The max_intra_rate of this Vp9VideoConfiguration.
- Return type
int
- property max_keyframe_interval
Gets the max_keyframe_interval of this Vp9VideoConfiguration.
Maximum interval in seconds between key frames
- Returns
The max_keyframe_interval of this Vp9VideoConfiguration.
- Return type
float
- property min_gop
Gets the min_gop of this Vp9VideoConfiguration.
Minimum GOP length, the minimum distance between I-frames.
- Returns
The min_gop of this Vp9VideoConfiguration.
- Return type
int
- property min_keyframe_interval
Gets the min_keyframe_interval of this Vp9VideoConfiguration.
Minimum interval in seconds between key frames
- Returns
The min_keyframe_interval of this Vp9VideoConfiguration.
- Return type
float
- property noise_sensitivity
Gets the noise_sensitivity of this Vp9VideoConfiguration.
Enable noise sensitivity on Y channel
- Returns
The noise_sensitivity of this Vp9VideoConfiguration.
- Return type
bool
- property openapi_types
- property preset_configuration
Gets the preset_configuration of this Vp9VideoConfiguration.
Choose from a set of preset configurations tailored for common use cases. Check out [VP9 Presets](https://bitmovin.com/docs/encoding/tutorials/vp9-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset’s value for that property.
- Returns
The preset_configuration of this Vp9VideoConfiguration.
- Return type
- property qp_max
Gets the qp_max of this Vp9VideoConfiguration.
Maximum quantization factor.
- Returns
The qp_max of this Vp9VideoConfiguration.
- Return type
int
- property qp_min
Gets the qp_min of this Vp9VideoConfiguration.
Minimum quantization factor.
- Returns
The qp_min of this Vp9VideoConfiguration.
- Return type
int
- property quality
Gets the quality of this Vp9VideoConfiguration.
- Returns
The quality of this Vp9VideoConfiguration.
- Return type
- property rate_overshoot_pct
Gets the rate_overshoot_pct of this Vp9VideoConfiguration.
Datarate overshoot (max) target (percentage).
- Returns
The rate_overshoot_pct of this Vp9VideoConfiguration.
- Return type
int
- property rate_undershoot_pct
Gets the rate_undershoot_pct of this Vp9VideoConfiguration.
Datarate undershoot (min) target (percentage).
- Returns
The rate_undershoot_pct of this Vp9VideoConfiguration.
- Return type
int
- property row_multi_threading_enabled
Gets the row_multi_threading_enabled of this Vp9VideoConfiguration.
Enable row based non-deterministic multi-threading
- Returns
The row_multi_threading_enabled of this Vp9VideoConfiguration.
- Return type
bool
- property sharpness
Gets the sharpness of this Vp9VideoConfiguration.
Loop filter sharpness.
- Returns
The sharpness of this Vp9VideoConfiguration.
- Return type
int
- property static_thresh
Gets the static_thresh of this Vp9VideoConfiguration.
A change threshold on blocks below which they will be skipped by the encoder.
- Returns
The static_thresh of this Vp9VideoConfiguration.
- Return type
int
- property target_level
Gets the target_level of this Vp9VideoConfiguration.
Target level (255: off, 0: only keep level stats; 10: level 1.0; 11: level 1.1; … 62: level 6.2)
- Returns
The target_level of this Vp9VideoConfiguration.
- Return type
int
- property tile_columns
Gets the tile_columns of this Vp9VideoConfiguration.
Number of tile columns to use, log2. Depending on the encoding width there are limitations on this value. The minimum values are 2 for width >= 1920 and 1 for width >= 1280. The minimum width of each tile is 256 pixels so the maximum values are 0 for width < 256, 1 for width < 512, 2 for width < 1024, 3 for width < 2048, 4 for width < 4096, 5 for width < 8192. If the value is too high or too low it will be overridden.
- Returns
The tile_columns of this Vp9VideoConfiguration.
- Return type
int
- property tile_rows
Gets the tile_rows of this Vp9VideoConfiguration.
Number of tile rows to use, log2.
- Returns
The tile_rows of this Vp9VideoConfiguration.
- Return type
int
bitmovin_api_sdk.models.vtt_media_info module
- class bitmovin_api_sdk.models.vtt_media_info.VttMediaInfo(**kwargs)[source]
Bases:
BasicMediaInfo- property attribute_map
- property forced
Gets the forced of this VttMediaInfo.
A value of true indicates that the Rendition contains content which is considered essential to play.
- Returns
The forced of this VttMediaInfo.
- Return type
bool
- property openapi_types
- property uri
Gets the uri of this VttMediaInfo.
The URI of the Rendition (required)
- Returns
The uri of this VttMediaInfo.
- Return type
string_types
- property vtt_url
Gets the vtt_url of this VttMediaInfo.
The URL of the referenced VTT file (required)
- Returns
The vtt_url of this VttMediaInfo.
- Return type
string_types
bitmovin_api_sdk.models.watch_folder module
- class bitmovin_api_sdk.models.watch_folder.WatchFolder(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property input
Gets the input of this WatchFolder.
- Returns
The input of this WatchFolder.
- Return type
- property openapi_types
- property outputs
Gets the outputs of this WatchFolder.
- Returns
The outputs of this WatchFolder.
- Return type
list[WatchFolderOutput]
- property status
Gets the status of this WatchFolder.
The current status of the Watch Folder. The default value is STOPPED (required)
- Returns
The status of this WatchFolder.
- Return type
- property status_text
Gets the status_text of this WatchFolder.
A description text of the current status (required)
- Returns
The status_text of this WatchFolder.
- Return type
string_types
bitmovin_api_sdk.models.watch_folder_input module
- class bitmovin_api_sdk.models.watch_folder_input.WatchFolderInput(**kwargs)[source]
Bases:
object- property attribute_map
- property input_id
Gets the input_id of this WatchFolderInput.
Input id (required)
- Returns
The input_id of this WatchFolderInput.
- Return type
string_types
- property input_path
Gets the input_path of this WatchFolderInput.
Path of the directory to monitor (required)
- Returns
The input_path of this WatchFolderInput.
- Return type
string_types
- property openapi_types
bitmovin_api_sdk.models.watch_folder_output module
- class bitmovin_api_sdk.models.watch_folder_output.WatchFolderOutput(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property output_id
Gets the output_id of this WatchFolderOutput.
Id of the corresponding output (required)
- Returns
The output_id of this WatchFolderOutput.
- Return type
string_types
- property output_path
Gets the output_path of this WatchFolderOutput.
Subdirectory where to save the files to (required)
- Returns
The output_path of this WatchFolderOutput.
- Return type
string_types
bitmovin_api_sdk.models.watch_folder_status module
bitmovin_api_sdk.models.watermark_filter module
- class bitmovin_api_sdk.models.watermark_filter.WatermarkFilter(**kwargs)[source]
Bases:
Filter- property attribute_map
- property bottom
Gets the bottom of this WatermarkFilter.
Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if ‘top’ is set.
- Returns
The bottom of this WatermarkFilter.
- Return type
int
- property image
Gets the image of this WatermarkFilter.
URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)
- Returns
The image of this WatermarkFilter.
- Return type
string_types
- property left
Gets the left of this WatermarkFilter.
Distance from the left edge of the input video to the left edge of the watermark image. May not be set if ‘right’ is set.
- Returns
The left of this WatermarkFilter.
- Return type
int
- property openapi_types
- property right
Gets the right of this WatermarkFilter.
Distance from the right edge of the input video to the right edge of the watermark image . May not be set if ‘left’ is set.
- Returns
The right of this WatermarkFilter.
- Return type
int
- property top
Gets the top of this WatermarkFilter.
Distance from the top edge of the input video to the top edge of the watermark image. May not be set if ‘bottom’ is set.
- Returns
The top of this WatermarkFilter.
- Return type
int
- property unit
Gets the unit of this WatermarkFilter.
Specifies if the values of ‘left’, ‘right’, ‘top’ and ‘bottom’ are interpreted as pixels or as a percentage of the input video’s dimensions.
- Returns
The unit of this WatermarkFilter.
- Return type
bitmovin_api_sdk.models.web_vtt_configuration module
- class bitmovin_api_sdk.models.web_vtt_configuration.WebVttConfiguration(**kwargs)[source]
Bases:
SubtitleConfiguration- property append_optional_zero_hour
Gets the append_optional_zero_hour of this WebVttConfiguration.
If set to true, the hours section on webvtt timestamp values will explicitely have zeroes instead of being omitted for values where hours = 0.
- Returns
The append_optional_zero_hour of this WebVttConfiguration.
- Return type
bool
- property attribute_map
- property cue_identifier_policy
Gets the cue_identifier_policy of this WebVttConfiguration.
- Returns
The cue_identifier_policy of this WebVttConfiguration.
- Return type
- property ignore_region
Gets the ignore_region of this WebVttConfiguration.
If set to true, the region information of the resulting webvtt file will be omitted. Defaults to false.
- Returns
The ignore_region of this WebVttConfiguration.
- Return type
bool
- property openapi_types
- property styling
Gets the styling of this WebVttConfiguration.
- Returns
The styling of this WebVttConfiguration.
- Return type
bitmovin_api_sdk.models.web_vtt_cue_identifier_policy module
bitmovin_api_sdk.models.web_vtt_sidecar_file module
bitmovin_api_sdk.models.web_vtt_sidecar_file_segmentation module
- class bitmovin_api_sdk.models.web_vtt_sidecar_file_segmentation.WebVttSidecarFileSegmentation(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property segment_length
Gets the segment_length of this WebVttSidecarFileSegmentation.
The length of the WebVTT fragments in seconds (required)
- Returns
The segment_length of this WebVttSidecarFileSegmentation.
- Return type
float
bitmovin_api_sdk.models.web_vtt_styling module
bitmovin_api_sdk.models.web_vtt_styling_mode module
bitmovin_api_sdk.models.webhook module
- class bitmovin_api_sdk.models.webhook.Webhook(**kwargs)[source]
Bases:
BitmovinResource- property attribute_map
- property insecure_ssl
Gets the insecure_ssl of this Webhook.
Skip verification of the SSL certificate
- Returns
The insecure_ssl of this Webhook.
- Return type
bool
- property method
Gets the method of this Webhook.
HTTP method used for the webhook
- Returns
The method of this Webhook.
- Return type
- property openapi_types
- property schema
Gets the schema of this Webhook.
JSON schema of the webhook payload
- Returns
The schema of this Webhook.
- Return type
object
- property signature
Gets the signature of this Webhook.
Signature used for the webhook
- Returns
The signature of this Webhook.
- Return type
- property url
Gets the url of this Webhook.
Webhook URL (required)
- Returns
The url of this Webhook.
- Return type
string_types
bitmovin_api_sdk.models.webhook_http_method module
bitmovin_api_sdk.models.webhook_notification module
- class bitmovin_api_sdk.models.webhook_notification.WebhookNotification(**kwargs)[source]
Bases:
Notification- property attribute_map
- property insecure_ssl
Gets the insecure_ssl of this WebhookNotification.
Skip verification of the SSL certificate
- Returns
The insecure_ssl of this WebhookNotification.
- Return type
bool
- property method
Gets the method of this WebhookNotification.
HTTP method used for the webhook
- Returns
The method of this WebhookNotification.
- Return type
- property openapi_types
- property signature
Gets the signature of this WebhookNotification.
Signature used for the webhook
- Returns
The signature of this WebhookNotification.
- Return type
- property url
Gets the url of this WebhookNotification.
The destination URL where the webhook data is send to (required)
- Returns
The url of this WebhookNotification.
- Return type
string_types
bitmovin_api_sdk.models.webhook_notification_with_stream_conditions module
- class bitmovin_api_sdk.models.webhook_notification_with_stream_conditions.WebhookNotificationWithStreamConditions(**kwargs)[source]
Bases:
WebhookNotification- property attribute_map
- property conditions
Gets the conditions of this WebhookNotificationWithStreamConditions.
- Returns
The conditions of this WebhookNotificationWithStreamConditions.
- Return type
- property openapi_types
bitmovin_api_sdk.models.webhook_notification_with_stream_conditions_request module
- class bitmovin_api_sdk.models.webhook_notification_with_stream_conditions_request.WebhookNotificationWithStreamConditionsRequest(**kwargs)[source]
Bases:
WebhookNotification- property attribute_map
- property conditions
Gets the conditions of this WebhookNotificationWithStreamConditionsRequest.
- Returns
The conditions of this WebhookNotificationWithStreamConditionsRequest.
- Return type
- property openapi_types
bitmovin_api_sdk.models.webhook_signature module
- class bitmovin_api_sdk.models.webhook_signature.WebhookSignature(**kwargs)[source]
Bases:
object- property attribute_map
- property key
Gets the key of this WebhookSignature.
The key of the signature (required)
- Returns
The key of this WebhookSignature.
- Return type
string_types
- property openapi_types
- property type
Gets the type of this WebhookSignature.
The signature type used for the webhook. Selects one of the supported signatures. The signature is attached to the list of headers with the key Bitmovin-Signature. In case of the HMAC type the SHA512 hashing algorithm is used to generate an authentication code from the webhook body. (required)
- Returns
The type of this WebhookSignature.
- Return type
bitmovin_api_sdk.models.webm_muxing module
- class bitmovin_api_sdk.models.webm_muxing.WebmMuxing(**kwargs)[source]
Bases:
Muxing- property attribute_map
- property init_segment_name
Gets the init_segment_name of this WebmMuxing.
Init segment name
- Returns
The init_segment_name of this WebmMuxing.
- Return type
string_types
- property init_segment_name_template
Gets the init_segment_name_template of this WebmMuxing.
Segment naming policy containing a placeholder of the format ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.
- Returns
The init_segment_name_template of this WebmMuxing.
- Return type
string_types
- property openapi_types
- property segment_length
Gets the segment_length of this WebmMuxing.
Length of the fragments in seconds (required)
- Returns
The segment_length of this WebmMuxing.
- Return type
float
- property segment_naming
Gets the segment_naming of this WebmMuxing.
Segment naming policy
- Returns
The segment_naming of this WebmMuxing.
- Return type
string_types
- property segment_naming_template
Gets the segment_naming_template of this WebmMuxing.
Segment naming policy containing one or both of the following placeholders: - ‘{rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. - ‘{segment_rand_chars:x}’, which will be replaced by a random alphanumeric string of length x (default 32) for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers. If segmentNamingTemplate is set, segmentNaming must not be set.
- Returns
The segment_naming_template of this WebmMuxing.
- Return type
string_types
- property segments_muxed
Gets the segments_muxed of this WebmMuxing.
Number of segments which have been encoded
- Returns
The segments_muxed of this WebmMuxing.
- Return type
int
bitmovin_api_sdk.models.weighted_prediction_p_frames module
bitmovin_api_sdk.models.widevine_drm module
- class bitmovin_api_sdk.models.widevine_drm.WidevineDrm(**kwargs)[source]
Bases:
Drm- property attribute_map
- property key
Gets the key of this WidevineDrm.
16 byte Encryption key, 32 hexadecimal characters (required)
- Returns
The key of this WidevineDrm.
- Return type
string_types
- property kid
Gets the kid of this WidevineDrm.
16 byte Key id, 32 hexadecimal characters (required)
- Returns
The kid of this WidevineDrm.
- Return type
string_types
- property openapi_types
- property pssh
Gets the pssh of this WidevineDrm.
Base 64 Encoded (required)
- Returns
The pssh of this WidevineDrm.
- Return type
string_types
bitmovin_api_sdk.models.xml_namespace module
- class bitmovin_api_sdk.models.xml_namespace.XmlNamespace(**kwargs)[source]
Bases:
object- property attribute_map
- property openapi_types
- property prefix
Gets the prefix of this XmlNamespace.
Name of the XML Namespace reference (required)
- Returns
The prefix of this XmlNamespace.
- Return type
string_types
- property uri
Gets the uri of this XmlNamespace.
Source of the XML Namespace reference (required)
- Returns
The uri of this XmlNamespace.
- Return type
string_types
bitmovin_api_sdk.models.zixi_input module
- class bitmovin_api_sdk.models.zixi_input.ZixiInput(**kwargs)[source]
Bases:
Input- property attribute_map
- property decryption_key
Gets the decryption_key of this ZixiInput.
- Returns
The decryption_key of this ZixiInput.
- Return type
string_types
- property decryption_type
Gets the decryption_type of this ZixiInput.
- Returns
The decryption_type of this ZixiInput.
- Return type
string_types
- property host
Gets the host of this ZixiInput.
- Returns
The host of this ZixiInput.
- Return type
string_types
- property latency
Gets the latency of this ZixiInput.
- Returns
The latency of this ZixiInput.
- Return type
int
- property min_bitrate
Gets the min_bitrate of this ZixiInput.
- Returns
The min_bitrate of this ZixiInput.
- Return type
int
- property openapi_types
- property password
Gets the password of this ZixiInput.
- Returns
The password of this ZixiInput.
- Return type
string_types
- property port
Gets the port of this ZixiInput.
- Returns
The port of this ZixiInput.
- Return type
int
- property stream
Gets the stream of this ZixiInput.
- Returns
The stream of this ZixiInput.
- Return type
string_types