docs/html/_sources/api_aliasing.txt
.. _ref-api_aliasing:
========
Aliasing
========
``add_stream_alias``
====================
Allows you to create secondary name(s) for internal streams. Once an alias is
created the localstreamname cannot be used to request playback of that stream.
Once an alias is used (requested by a client) the alias is removed. Aliases
are designed to be used to protect/hide your source streams.
Required:
:``localStreamName`` `(str)`:
The original stream name.
:``aliasName`` `(str)`:
The alias alternative to the `localStreamName`.
Optional:
:``expirePeriod`` `(int)`:
The expiration period for this alias. Negative values will be treated as
one-shot but no longer than the absolute positive value in seconds,
0 means it will not expire, positive values mean the alias can be used
multiple times but expires after this many seconds.
The default is -600 (one-shot, 10 mins).
Example:
.. sourcecode:: python
api.add_stream_alias('bunny', 'video1', expirePeriod=-300)
http://docs.evostream.com/ems_api_definition/addstreamalias
``list_stream_aliases``
=======================
Returns a complete list of aliases.
Example:
.. sourcecode:: python
api.list_stream_aliases()
http://docs.evostream.com/ems_api_definition/liststreamaliases
``remove_stream_alias``
=======================
Removes an alias of a stream.
Required:
:``aliasName`` `(str)`:
The alias to delete
Example:
.. sourcecode:: python
api.emove_stream_alias(aliasName='video1')
http://docs.evostream.com/ems_api_definition/removestreamalias
``flush_stream_aliases``
========================
Invalidates all streams aliases.
Example:
.. sourcecode:: python
api.flush_stream_aliases()
http://docs.evostream.com/ems_api_definition/flushstreamaliases
``add_group_name_alias``
========================
Create secondary name for group name.
Required:
:``groupName`` `(str)`:
The original group name.
:``aliasName`` `(str)`:
The alias alternative to the group name.
Example:
.. sourcecode:: python
api.add_group_name_alias(groupName='MyGroup', aliasName='TestGroupAlias')
http://docs.evostream.com/ems_api_definition/addgroupnamealias
``flush_group_name_aliases``
============================
Invalidates all group name aliases.
Example:
.. sourcecode:: python
api.flush_group_name_aliases()
http://docs.evostream.com/ems_api_definition/flushgroupnamealiases
``get_group_name_by_alias``
===========================
Returns the group name given the alias name.
Required:
:``aliasName`` `(str)`:
The group name alias.
Example:
.. sourcecode:: python
api.get_group_name_by_alias(aliasName='TestGroupAlias')
http://docs.evostream.com/ems_api_definition/getgroupnamebyalias
``list_group_name_aliases``
===========================
Returns a complete list of group name aliases.
Example:
.. sourcecode:: python
api.list_group_name_aliases()
http://docs.evostream.com/ems_api_definition/listgroupnamealiases
``remove_group_name_alias``
===========================
Removes an alias of a group.
Required:
:``aliasName`` `(str)`:
The alias alternative to be removed from the group name.
Example:
.. sourcecode:: python
api.remove_group_name_alias(aliasName='TestGroupAlias')
http://docs.evostream.com/ems_api_definition/removegroupnamealiases
``list_http_streaming_sessions``
================================
Lists all currently active HTTP streaming sessions.
Example:
.. sourcecode:: python
api.list_http_streaming_sessions()
http://docs.evostream.com/ems_api_definition/listhttpstreamingsessions
``create_ingest_point``
=======================
Creates an RTMP ingest point, which mandates that streams pushed into the
EMS have a target stream name which matches one Ingest Point
privateStreamName.
Required:
:``privateStreamName`` `(str)`:
The name that RTMP Target Stream Names must match.
:``publicStreamName`` `(str)`:
The name that is used to access the stream pushed to the `privateStreamName`.
The `publicStreamName` becomes the streams `localStreamName`.
Example:
.. sourcecode:: python
api.create_ingest_point(privateStreamName='theIngestPoint', publicStreamName='useMeToViewStream')
http://docs.evostream.com/ems_api_definition/createingestpoint
``remove_ingest_point``
=======================
Removes an RTMP ingest point.
Required:
:``privateStreamName`` `(str)`:
The Ingest Point is identified by the `privateStreamName`, so only that is
required to delete it.
Example:
.. sourcecode:: python
api.remove_ingest_point(privateStreamName='theIngestPoint')
http://docs.evostream.com/ems_api_definition/removeingestpoint
``list_ingest_points``
======================
Lists the currently available Ingest Points.
Example:
.. sourcecode:: python
api.list_ingest_points()
http://docs.evostream.com/ems_api_definition/listingestpoints