# coding: utf-8
from enum import Enum
from six import string_types, iteritems
from bitmovin_api_sdk.common.poscheck import poscheck_model
from bitmovin_api_sdk.models.bitmovin_response import BitmovinResponse
import pprint
import six
[docs]
class ResetLiveManifestTimeShift(BitmovinResponse):
@poscheck_model
def __init__(self,
id_=None,
residual_period_in_seconds=None,
offset_in_seconds=None,
manifest_ids=None,
shift_progressive_muxing_start_position=None):
# type: (string_types, float, float, list[string_types], bool) -> None
super(ResetLiveManifestTimeShift, self).__init__(id_=id_)
self._residual_period_in_seconds = None
self._offset_in_seconds = None
self._manifest_ids = list()
self._shift_progressive_muxing_start_position = None
self.discriminator = None
if residual_period_in_seconds is not None:
self.residual_period_in_seconds = residual_period_in_seconds
if offset_in_seconds is not None:
self.offset_in_seconds = offset_in_seconds
if manifest_ids is not None:
self.manifest_ids = manifest_ids
if shift_progressive_muxing_start_position is not None:
self.shift_progressive_muxing_start_position = shift_progressive_muxing_start_position
@property
def openapi_types(self):
types = {}
if hasattr(super(ResetLiveManifestTimeShift, self), 'openapi_types'):
types = getattr(super(ResetLiveManifestTimeShift, self), 'openapi_types')
types.update({
'residual_period_in_seconds': 'float',
'offset_in_seconds': 'float',
'manifest_ids': 'list[string_types]',
'shift_progressive_muxing_start_position': 'bool'
})
return types
@property
def attribute_map(self):
attributes = {}
if hasattr(super(ResetLiveManifestTimeShift, self), 'attribute_map'):
attributes = getattr(super(ResetLiveManifestTimeShift, self), 'attribute_map')
attributes.update({
'residual_period_in_seconds': 'residualPeriodInSeconds',
'offset_in_seconds': 'offsetInSeconds',
'manifest_ids': 'manifestIds',
'shift_progressive_muxing_start_position': 'shiftProgressiveMuxingStartPosition'
})
return attributes
@property
def residual_period_in_seconds(self):
# type: () -> float
"""Gets the residual_period_in_seconds of this ResetLiveManifestTimeShift.
Specifies how many seconds of content remain in the manifest after older segments are removed. At least one segment is always retained. If neither `residualPeriodInSeconds` nor `offsetInSeconds` is set, all segments except the most recent are removed. For DASH manifests that use SegmentTemplate, the retained duration also includes the value configured for `liveEdgeOffset`.
:return: The residual_period_in_seconds of this ResetLiveManifestTimeShift.
:rtype: float
"""
return self._residual_period_in_seconds
@residual_period_in_seconds.setter
def residual_period_in_seconds(self, residual_period_in_seconds):
# type: (float) -> None
"""Sets the residual_period_in_seconds of this ResetLiveManifestTimeShift.
Specifies how many seconds of content remain in the manifest after older segments are removed. At least one segment is always retained. If neither `residualPeriodInSeconds` nor `offsetInSeconds` is set, all segments except the most recent are removed. For DASH manifests that use SegmentTemplate, the retained duration also includes the value configured for `liveEdgeOffset`.
:param residual_period_in_seconds: The residual_period_in_seconds of this ResetLiveManifestTimeShift.
:type: float
"""
if residual_period_in_seconds is not None:
if not isinstance(residual_period_in_seconds, (float, int)):
raise TypeError("Invalid type for `residual_period_in_seconds`, type has to be `float`")
self._residual_period_in_seconds = residual_period_in_seconds
@property
def offset_in_seconds(self):
# type: () -> float
"""Gets the offset_in_seconds of this ResetLiveManifestTimeShift.
Specifies an offset, in seconds, from the start of the live event. All segments before this position are removed from the affected manifests. For example, assume a segment length of 2 seconds and a configured `timeshift` of 120 seconds (2 minutes). If the most recent segment is `segment_80.ts`, the manifest contains 60 segments, from `segment_21.ts` through `segment_80.ts`. Setting `offsetInSeconds` to `120` sets the target segment number to 60 (`targetSegmentNumber = offsetInSeconds / segmentLength`). All segments before `segment_60.ts` are removed. Each affected manifest then contains `segment_60.ts` through `segment_80.ts`. *Note:* Do not set both `offsetInSeconds` and `residualPeriodInSeconds`.
:return: The offset_in_seconds of this ResetLiveManifestTimeShift.
:rtype: float
"""
return self._offset_in_seconds
@offset_in_seconds.setter
def offset_in_seconds(self, offset_in_seconds):
# type: (float) -> None
"""Sets the offset_in_seconds of this ResetLiveManifestTimeShift.
Specifies an offset, in seconds, from the start of the live event. All segments before this position are removed from the affected manifests. For example, assume a segment length of 2 seconds and a configured `timeshift` of 120 seconds (2 minutes). If the most recent segment is `segment_80.ts`, the manifest contains 60 segments, from `segment_21.ts` through `segment_80.ts`. Setting `offsetInSeconds` to `120` sets the target segment number to 60 (`targetSegmentNumber = offsetInSeconds / segmentLength`). All segments before `segment_60.ts` are removed. Each affected manifest then contains `segment_60.ts` through `segment_80.ts`. *Note:* Do not set both `offsetInSeconds` and `residualPeriodInSeconds`.
:param offset_in_seconds: The offset_in_seconds of this ResetLiveManifestTimeShift.
:type: float
"""
if offset_in_seconds is not None:
if not isinstance(offset_in_seconds, (float, int)):
raise TypeError("Invalid type for `offset_in_seconds`, type has to be `float`")
self._offset_in_seconds = offset_in_seconds
@property
def manifest_ids(self):
# type: () -> list[string_types]
"""Gets the manifest_ids of this ResetLiveManifestTimeShift.
The IDs of the manifests to update. If omitted, all supported manifests associated with the encoding are updated. HLS live manifests are supported. DASH live manifests require encoder version 2.235.0 or later.
:return: The manifest_ids of this ResetLiveManifestTimeShift.
:rtype: list[string_types]
"""
return self._manifest_ids
@manifest_ids.setter
def manifest_ids(self, manifest_ids):
# type: (list) -> None
"""Sets the manifest_ids of this ResetLiveManifestTimeShift.
The IDs of the manifests to update. If omitted, all supported manifests associated with the encoding are updated. HLS live manifests are supported. DASH live manifests require encoder version 2.235.0 or later.
:param manifest_ids: The manifest_ids of this ResetLiveManifestTimeShift.
:type: list[string_types]
"""
if manifest_ids is not None:
if not isinstance(manifest_ids, list):
raise TypeError("Invalid type for `manifest_ids`, type has to be `list[string_types]`")
self._manifest_ids = manifest_ids
@property
def shift_progressive_muxing_start_position(self):
# type: () -> bool
"""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.
:return: The shift_progressive_muxing_start_position of this ResetLiveManifestTimeShift.
:rtype: bool
"""
return self._shift_progressive_muxing_start_position
@shift_progressive_muxing_start_position.setter
def shift_progressive_muxing_start_position(self, shift_progressive_muxing_start_position):
# type: (bool) -> None
"""Sets 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.
:param shift_progressive_muxing_start_position: The shift_progressive_muxing_start_position of this ResetLiveManifestTimeShift.
:type: bool
"""
if shift_progressive_muxing_start_position is not None:
if not isinstance(shift_progressive_muxing_start_position, bool):
raise TypeError("Invalid type for `shift_progressive_muxing_start_position`, type has to be `bool`")
self._shift_progressive_muxing_start_position = shift_progressive_muxing_start_position
[docs]
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
if hasattr(super(ResetLiveManifestTimeShift, self), "to_dict"):
result = super(ResetLiveManifestTimeShift, self).to_dict()
for attr, _ in six.iteritems(self.openapi_types):
value = getattr(self, attr)
if value is None:
continue
if isinstance(value, list):
if len(value) == 0:
continue
result[self.attribute_map.get(attr)] = [y.value if isinstance(y, Enum) else y for y in [x.to_dict() if hasattr(x, "to_dict") else x for x in value]]
elif hasattr(value, "to_dict"):
result[self.attribute_map.get(attr)] = value.to_dict()
elif isinstance(value, Enum):
result[self.attribute_map.get(attr)] = value.value
elif isinstance(value, dict):
result[self.attribute_map.get(attr)] = {k: (v.to_dict() if hasattr(v, "to_dict") else v) for (k, v) in value.items()}
else:
result[self.attribute_map.get(attr)] = value
return result
[docs]
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, ResetLiveManifestTimeShift):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other