Skip to content

Commit

Permalink
Merge pull request #68 from apivideo/feat/live-restreaming
Browse files Browse the repository at this point in the history
Feat/live restreaming
  • Loading branch information
bot-api-video authored Jun 28, 2023
2 parents dd05fa2 + 4a219e1 commit c70fc90
Show file tree
Hide file tree
Showing 37 changed files with 590 additions and 21 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Changelog
All changes to this project will be documented in this file.

## [1.3.0] - 2023-06-19
## [1.3.0] - 2023-06-28
- Introducing live streams restream feature
- Introducing new analytics endpoints

## [1.2.8] - 2022-09-13
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,8 @@ Method | HTTP request | Description
- [RawStatisticsListPlayerSessionEventsResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/RawStatisticsListPlayerSessionEventsResponse.md)
- [RawStatisticsListSessionsResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/RawStatisticsListSessionsResponse.md)
- [RefreshTokenPayload](https://github.com/apivideo/api.video-python-client/blob/main/docs/RefreshTokenPayload.md)
- [RestreamsRequestObject](https://github.com/apivideo/api.video-python-client/blob/main/docs/RestreamsRequestObject.md)
- [RestreamsResponseObject](https://github.com/apivideo/api.video-python-client/blob/main/docs/RestreamsResponseObject.md)
- [TokenCreationPayload](https://github.com/apivideo/api.video-python-client/blob/main/docs/TokenCreationPayload.md)
- [TokenListResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/TokenListResponse.md)
- [UploadToken](https://github.com/apivideo/api.video-python-client/blob/main/docs/UploadToken.md)
Expand Down
8 changes: 7 additions & 1 deletion apivideo/model/live_stream.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@

def lazy_import():
from apivideo.model.live_stream_assets import LiveStreamAssets
from apivideo.model.restreams_response_object import RestreamsResponseObject
globals()['LiveStreamAssets'] = LiveStreamAssets
globals()['RestreamsResponseObject'] = RestreamsResponseObject


class LiveStream(ModelNormal):
Expand Down Expand Up @@ -77,6 +79,7 @@ def openapi_types():
lazy_import()
return {
'live_stream_id': (str,), # noqa: E501
'restreams': ([RestreamsResponseObject],), # noqa: E501
'name': (str,), # noqa: E501
'stream_key': (str,), # noqa: E501
'record': (bool,), # noqa: E501
Expand All @@ -95,6 +98,7 @@ def discriminator():

attribute_map = {
'live_stream_id': 'liveStreamId', # noqa: E501
'restreams': 'restreams', # noqa: E501
'name': 'name', # noqa: E501
'stream_key': 'streamKey', # noqa: E501
'record': 'record', # noqa: E501
Expand All @@ -118,11 +122,12 @@ def discriminator():
])

@convert_js_args_to_python_args
def __init__(self, live_stream_id, *args, **kwargs): # noqa: E501
def __init__(self, live_stream_id, restreams, *args, **kwargs): # noqa: E501
"""LiveStream - a model defined in OpenAPI
Args:
live_stream_id (str): The unique identifier for the live stream. Live stream IDs begin with \"li.\"
restreams ([RestreamsResponseObject]): Returns the list of RTMP restream destinations.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
Expand Down Expand Up @@ -190,6 +195,7 @@ def __init__(self, live_stream_id, *args, **kwargs): # noqa: E501
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)

self.live_stream_id = live_stream_id
self.restreams = restreams
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
Expand Down
11 changes: 11 additions & 0 deletions apivideo/model/live_stream_creation_payload.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
validate_get_composed_info,
)

def lazy_import():
from apivideo.model.restreams_request_object import RestreamsRequestObject
globals()['RestreamsRequestObject'] = RestreamsRequestObject


class LiveStreamCreationPayload(ModelNormal):
"""NOTE: This class is auto generated by OpenAPI Generator.
Expand Down Expand Up @@ -54,6 +58,9 @@ class LiveStreamCreationPayload(ModelNormal):
}

validations = {
('restreams',): {
'max_items': 5,
},
}

additional_properties_type = None
Expand All @@ -70,11 +77,13 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
lazy_import()
return {
'name': (str,), # noqa: E501
'record': (bool,), # noqa: E501
'public': (bool,), # noqa: E501
'player_id': (str,), # noqa: E501
'restreams': ([RestreamsRequestObject],), # noqa: E501
}

@cached_property
Expand All @@ -87,6 +96,7 @@ def discriminator():
'record': 'record', # noqa: E501
'public': 'public', # noqa: E501
'player_id': 'playerId', # noqa: E501
'restreams': 'restreams', # noqa: E501
}

_composed_schemas = {}
Expand Down Expand Up @@ -141,6 +151,7 @@ def __init__(self, name, *args, **kwargs): # noqa: E501
record (bool): Whether you are recording or not. True for record, false for not record.. [optional] if omitted the server will use the default value of False # noqa: E501
public (bool): Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos).. [optional] # noqa: E501
player_id (str): The unique identifier for the player.. [optional] # noqa: E501
restreams ([RestreamsRequestObject]): Use this parameter to add, edit, or remove RTMP services where you want to restream a live stream. The list can only contain up to 5 destinations.. [optional] # noqa: E501
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
11 changes: 11 additions & 0 deletions apivideo/model/live_stream_update_payload.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
validate_get_composed_info,
)

def lazy_import():
from apivideo.model.restreams_request_object import RestreamsRequestObject
globals()['RestreamsRequestObject'] = RestreamsRequestObject


class LiveStreamUpdatePayload(ModelNormal):
"""NOTE: This class is auto generated by OpenAPI Generator.
Expand Down Expand Up @@ -54,6 +58,9 @@ class LiveStreamUpdatePayload(ModelNormal):
}

validations = {
('restreams',): {
'max_items': 5,
},
}

additional_properties_type = None
Expand All @@ -70,11 +77,13 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
lazy_import()
return {
'name': (str,), # noqa: E501
'public': (bool,), # noqa: E501
'record': (bool,), # noqa: E501
'player_id': (str,), # noqa: E501
'restreams': ([RestreamsRequestObject],), # noqa: E501
}

@cached_property
Expand All @@ -87,6 +96,7 @@ def discriminator():
'public': 'public', # noqa: E501
'record': 'record', # noqa: E501
'player_id': 'playerId', # noqa: E501
'restreams': 'restreams', # noqa: E501
}

_composed_schemas = {}
Expand Down Expand Up @@ -139,6 +149,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
public (bool): Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos).. [optional] # noqa: E501
record (bool): Use this to indicate whether you want the recording on or off. On is true, off is false.. [optional] # noqa: E501
player_id (str): The unique ID for the player associated with a live stream that you want to update.. [optional] # noqa: E501
restreams ([RestreamsRequestObject]): Use this parameter to add, edit, or remove RTMP services where you want to restream a live stream. The list can only contain up to 5 destinations. This operation updates all restream destinations in the same request. If you do not want to modify an existing restream destination, you need to include it in your request, otherwise it is removed.. [optional] # noqa: E501
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
176 changes: 176 additions & 0 deletions apivideo/model/restreams_request_object.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
"""
api.video
api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. # noqa: E501
Contact: ecosystem@api.video
"""


import re # noqa: F401
import sys # noqa: F401

from apivideo.model_utils import ( # noqa: F401
ApiTypeError,
ModelComposed,
ModelNormal,
ModelSimple,
cached_property,
change_keys_js_to_python,
convert_js_args_to_python_args,
date,
datetime,
file_type,
none_type,
validate_get_composed_info,
)


class RestreamsRequestObject(ModelNormal):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Do not edit the class manually.
Attributes:
allowed_values (dict): The key is the tuple path to the attribute
and the for var_name this is (var_name,). The value is a dict
with a capitalized key describing the allowed value and an allowed
value. These dicts store the allowed enum values.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
discriminator_value_class_map (dict): A dict to go from the discriminator
variable value to the discriminator class name.
validations (dict): The key is the tuple path to the attribute
and the for var_name this is (var_name,). The value is a dict
that stores validations for max_length, min_length, max_items,
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
inclusive_minimum, and regex.
additional_properties_type (tuple): A tuple of classes accepted
as additional properties values.
"""

allowed_values = {
}

validations = {
}

additional_properties_type = None

_nullable = False

@cached_property
def openapi_types():
"""
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
Returns
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
return {
'name': (str,), # noqa: E501
'server_url': (str,), # noqa: E501
'stream_key': (str,), # noqa: E501
}

@cached_property
def discriminator():
return None


attribute_map = {
'name': 'name', # noqa: E501
'server_url': 'serverUrl', # noqa: E501
'stream_key': 'streamKey', # noqa: E501
}

_composed_schemas = {}

required_properties = set([
'_data_store',
'_check_type',
'_spec_property_naming',
'_path_to_item',
'_configuration',
'_visited_composed_classes',
])

@convert_js_args_to_python_args
def __init__(self, name, server_url, stream_key, *args, **kwargs): # noqa: E501
"""RestreamsRequestObject - a model defined in OpenAPI
Args:
name (str): Use this parameter to define a name for the restream destination.
server_url (str): Use this parameter to set the RTMP URL of the restream destination.
stream_key (str): Use this parameter to provide the unique key of the live stream that you want to restream.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
Defaults to True
_path_to_item (tuple/list): This is a list of keys or values to
drill down to the model in received_data
when deserializing a response
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_configuration (Configuration): the instance to use when
deserializing a file_type parameter.
If passed, type conversion is attempted
If omitted no type conversion is done.
_visited_composed_classes (tuple): This stores a tuple of
classes that we have traveled through so that
if we see that class again we will not use its
discriminator again.
When traveling through a discriminator, the
composed schema that is
is traveled through is added to this set.
For example if Animal has a discriminator
petType and we pass in "Dog", and the class Dog
allOf includes Animal, we move through Animal
once using the discriminator, and pick Dog.
Then in Dog, we will make an instance of the
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
"""

_check_type = kwargs.pop('_check_type', True)
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
_path_to_item = kwargs.pop('_path_to_item', ())
_configuration = kwargs.pop('_configuration', None)
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())

if args:
raise ApiTypeError(
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
args,
self.__class__.__name__,
),
path_to_item=_path_to_item,
valid_classes=(self.__class__,),
)

self._data_store = {}
self._check_type = _check_type
self._spec_property_naming = _spec_property_naming
self._path_to_item = _path_to_item
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)

self.name = name
self.server_url = server_url
self.stream_key = stream_key
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
self._configuration.discard_unknown_keys and \
self.additional_properties_type is None:
# discard variable.
continue
setattr(self, var_name, var_value)
Loading

0 comments on commit c70fc90

Please sign in to comment.