# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import deserialize
from twilio.base import serialize
from twilio.base import values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page
[docs]class RecordingList(ListResource):
def __init__(self, version):
"""
Initialize the RecordingList
:param Version version: Version that contains the resource
:returns: twilio.rest.video.v1.recording.RecordingList
:rtype: twilio.rest.video.v1.recording.RecordingList
"""
super(RecordingList, self).__init__(version)
# Path Solution
self._solution = {}
self._uri = '/Recordings'.format(**self._solution)
[docs] def stream(self, status=values.unset, source_sid=values.unset,
grouping_sid=values.unset, date_created_after=values.unset,
date_created_before=values.unset, media_type=values.unset,
limit=None, page_size=None):
"""
Streams RecordingInstance records from the API as a generator stream.
This operation lazily loads records as efficiently as possible until the limit
is reached.
The results are returned as a generator, so this operation is memory efficient.
:param RecordingInstance.Status status: Read only the recordings that have this status
:param unicode source_sid: Read only the recordings that have this source_sid
:param list[unicode] grouping_sid: Read only recordings that have this grouping_sid
:param datetime date_created_after: Read only recordings that started on or after this `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ date-time with time zone
:param datetime date_created_before: Read only recordings that started before this `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ date-time with time zone
:param RecordingInstance.Type media_type: Read only recordings that have this media type
:param int limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the
limit with the most efficient page size, i.e. min(limit, 1000)
:returns: Generator that will yield up to limit results
:rtype: list[twilio.rest.video.v1.recording.RecordingInstance]
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(
status=status,
source_sid=source_sid,
grouping_sid=grouping_sid,
date_created_after=date_created_after,
date_created_before=date_created_before,
media_type=media_type,
page_size=limits['page_size'],
)
return self._version.stream(page, limits['limit'])
[docs] def list(self, status=values.unset, source_sid=values.unset,
grouping_sid=values.unset, date_created_after=values.unset,
date_created_before=values.unset, media_type=values.unset, limit=None,
page_size=None):
"""
Lists RecordingInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param RecordingInstance.Status status: Read only the recordings that have this status
:param unicode source_sid: Read only the recordings that have this source_sid
:param list[unicode] grouping_sid: Read only recordings that have this grouping_sid
:param datetime date_created_after: Read only recordings that started on or after this `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ date-time with time zone
:param datetime date_created_before: Read only recordings that started before this `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ date-time with time zone
:param RecordingInstance.Type media_type: Read only recordings that have this media type
:param int limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, list() will attempt to read the limit
with the most efficient page size, i.e. min(limit, 1000)
:returns: Generator that will yield up to limit results
:rtype: list[twilio.rest.video.v1.recording.RecordingInstance]
"""
return list(self.stream(
status=status,
source_sid=source_sid,
grouping_sid=grouping_sid,
date_created_after=date_created_after,
date_created_before=date_created_before,
media_type=media_type,
limit=limit,
page_size=page_size,
))
[docs] def page(self, status=values.unset, source_sid=values.unset,
grouping_sid=values.unset, date_created_after=values.unset,
date_created_before=values.unset, media_type=values.unset,
page_token=values.unset, page_number=values.unset,
page_size=values.unset):
"""
Retrieve a single page of RecordingInstance records from the API.
Request is executed immediately
:param RecordingInstance.Status status: Read only the recordings that have this status
:param unicode source_sid: Read only the recordings that have this source_sid
:param list[unicode] grouping_sid: Read only recordings that have this grouping_sid
:param datetime date_created_after: Read only recordings that started on or after this `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ date-time with time zone
:param datetime date_created_before: Read only recordings that started before this `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ date-time with time zone
:param RecordingInstance.Type media_type: Read only recordings that have this media type
:param str page_token: PageToken provided by the API
:param int page_number: Page Number, this value is simply for client state
:param int page_size: Number of records to return, defaults to 50
:returns: Page of RecordingInstance
:rtype: twilio.rest.video.v1.recording.RecordingPage
"""
data = values.of({
'Status': status,
'SourceSid': source_sid,
'GroupingSid': serialize.map(grouping_sid, lambda e: e),
'DateCreatedAfter': serialize.iso8601_datetime(date_created_after),
'DateCreatedBefore': serialize.iso8601_datetime(date_created_before),
'MediaType': media_type,
'PageToken': page_token,
'Page': page_number,
'PageSize': page_size,
})
response = self._version.page(method='GET', uri=self._uri, params=data, )
return RecordingPage(self._version, response, self._solution)
[docs] def get_page(self, target_url):
"""
Retrieve a specific page of RecordingInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of RecordingInstance
:rtype: twilio.rest.video.v1.recording.RecordingPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return RecordingPage(self._version, response, self._solution)
[docs] def get(self, sid):
"""
Constructs a RecordingContext
:param sid: The SID that identifies the resource to fetch
:returns: twilio.rest.video.v1.recording.RecordingContext
:rtype: twilio.rest.video.v1.recording.RecordingContext
"""
return RecordingContext(self._version, sid=sid, )
def __call__(self, sid):
"""
Constructs a RecordingContext
:param sid: The SID that identifies the resource to fetch
:returns: twilio.rest.video.v1.recording.RecordingContext
:rtype: twilio.rest.video.v1.recording.RecordingContext
"""
return RecordingContext(self._version, sid=sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Video.V1.RecordingList>'
[docs]class RecordingPage(Page):
def __init__(self, version, response, solution):
"""
Initialize the RecordingPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:returns: twilio.rest.video.v1.recording.RecordingPage
:rtype: twilio.rest.video.v1.recording.RecordingPage
"""
super(RecordingPage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of RecordingInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.video.v1.recording.RecordingInstance
:rtype: twilio.rest.video.v1.recording.RecordingInstance
"""
return RecordingInstance(self._version, payload, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Video.V1.RecordingPage>'
[docs]class RecordingContext(InstanceContext):
def __init__(self, version, sid):
"""
Initialize the RecordingContext
:param Version version: Version that contains the resource
:param sid: The SID that identifies the resource to fetch
:returns: twilio.rest.video.v1.recording.RecordingContext
:rtype: twilio.rest.video.v1.recording.RecordingContext
"""
super(RecordingContext, self).__init__(version)
# Path Solution
self._solution = {'sid': sid, }
self._uri = '/Recordings/{sid}'.format(**self._solution)
[docs] def fetch(self):
"""
Fetch the RecordingInstance
:returns: The fetched RecordingInstance
:rtype: twilio.rest.video.v1.recording.RecordingInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return RecordingInstance(self._version, payload, sid=self._solution['sid'], )
[docs] def delete(self):
"""
Deletes the RecordingInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._version.delete(method='DELETE', uri=self._uri, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Video.V1.RecordingContext {}>'.format(context)
[docs]class RecordingInstance(InstanceResource):
[docs] class Status(object):
PROCESSING = "processing"
COMPLETED = "completed"
DELETED = "deleted"
FAILED = "failed"
[docs] class Type(object):
AUDIO = "audio"
VIDEO = "video"
DATA = "data"
[docs] class Codec(object):
VP8 = "VP8"
H264 = "H264"
OPUS = "OPUS"
PCMU = "PCMU"
def __init__(self, version, payload, sid=None):
"""
Initialize the RecordingInstance
:returns: twilio.rest.video.v1.recording.RecordingInstance
:rtype: twilio.rest.video.v1.recording.RecordingInstance
"""
super(RecordingInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'account_sid': payload.get('account_sid'),
'status': payload.get('status'),
'date_created': deserialize.iso8601_datetime(payload.get('date_created')),
'sid': payload.get('sid'),
'source_sid': payload.get('source_sid'),
'size': deserialize.integer(payload.get('size')),
'url': payload.get('url'),
'type': payload.get('type'),
'duration': deserialize.integer(payload.get('duration')),
'container_format': payload.get('container_format'),
'codec': payload.get('codec'),
'grouping_sids': payload.get('grouping_sids'),
'track_name': payload.get('track_name'),
'offset': deserialize.integer(payload.get('offset')),
'links': payload.get('links'),
}
# Context
self._context = None
self._solution = {'sid': sid or self._properties['sid'], }
@property
def _proxy(self):
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: RecordingContext for this RecordingInstance
:rtype: twilio.rest.video.v1.recording.RecordingContext
"""
if self._context is None:
self._context = RecordingContext(self._version, sid=self._solution['sid'], )
return self._context
@property
def account_sid(self):
"""
:returns: The SID of the Account that created the resource
:rtype: unicode
"""
return self._properties['account_sid']
@property
def status(self):
"""
:returns: The status of the recording
:rtype: RecordingInstance.Status
"""
return self._properties['status']
@property
def date_created(self):
"""
:returns: The ISO 8601 date and time in GMT when the resource was created
:rtype: datetime
"""
return self._properties['date_created']
@property
def sid(self):
"""
:returns: The unique string that identifies the resource
:rtype: unicode
"""
return self._properties['sid']
@property
def source_sid(self):
"""
:returns: The SID of the recording source
:rtype: unicode
"""
return self._properties['source_sid']
@property
def size(self):
"""
:returns: The size of the recorded track, in bytes
:rtype: unicode
"""
return self._properties['size']
@property
def url(self):
"""
:returns: The absolute URL of the resource
:rtype: unicode
"""
return self._properties['url']
@property
def type(self):
"""
:returns: The recording's media type
:rtype: RecordingInstance.Type
"""
return self._properties['type']
@property
def duration(self):
"""
:returns: The duration of the recording in seconds
:rtype: unicode
"""
return self._properties['duration']
@property
def container_format(self):
"""
:returns: The file format for the recording
:rtype: RecordingInstance.Format
"""
return self._properties['container_format']
@property
def codec(self):
"""
:returns: The codec used to encode the track
:rtype: RecordingInstance.Codec
"""
return self._properties['codec']
@property
def grouping_sids(self):
"""
:returns: A list of SIDs related to the recording
:rtype: dict
"""
return self._properties['grouping_sids']
@property
def track_name(self):
"""
:returns: The name that was given to the source track of the recording
:rtype: unicode
"""
return self._properties['track_name']
@property
def offset(self):
"""
:returns: The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started
:rtype: unicode
"""
return self._properties['offset']
@property
def links(self):
"""
:returns: The URLs of related resources
:rtype: unicode
"""
return self._properties['links']
[docs] def fetch(self):
"""
Fetch the RecordingInstance
:returns: The fetched RecordingInstance
:rtype: twilio.rest.video.v1.recording.RecordingInstance
"""
return self._proxy.fetch()
[docs] def delete(self):
"""
Deletes the RecordingInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._proxy.delete()
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Video.V1.RecordingInstance {}>'.format(context)