:right-sidebar: True

StreamCollection
===================================================================

.. currentmodule:: gi.repository.Gst


.. versionadded:: 1.10




.. class:: StreamCollection(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gst.Object`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`





:Constructors:

::

    StreamCollection(**properties)
    new(upstream_id:str=None) -> Gst.StreamCollection



Constructors
------------

.. rst-class:: interim-class

.. class:: StreamCollection
   :no-index:


   .. classmethod:: new(upstream_id: str | None = None) -> ~gi.repository.Gst.StreamCollection

      Create a new :obj:`~gi.repository.Gst.StreamCollection`.



      .. versionadded:: 1.10





      :param upstream_id: The stream id of the parent stream









Methods
-------

.. rst-class:: interim-class

.. class:: StreamCollection
   :no-index:


   .. method:: add_stream(stream: ~gi.repository.Gst.Stream) -> bool

      Add the given ``stream`` to the ``collection``.



      .. versionadded:: 1.10





      :param stream: the :obj:`~gi.repository.Gst.Stream` to add





   .. method:: get_size() -> int

      Get the number of streams this collection contains



      .. versionadded:: 1.10








   .. method:: get_stream(index: int) -> ~gi.repository.Gst.Stream | None

      Retrieve the :obj:`~gi.repository.Gst.Stream` with index ``index`` from the collection.

      The caller should not modify the returned :obj:`~gi.repository.Gst.Stream`



      .. versionadded:: 1.10





      :param index: Index of the stream to retrieve





   .. method:: get_upstream_id() -> str | None

      Returns the upstream id of the ``collection``.



      .. versionadded:: 1.10












Properties
----------

.. rst-class:: interim-class

.. class:: StreamCollection
   :no-index:
   

   .. attribute:: props.upstream_id
      :type: str

      stream-id











Signals
-------

.. rst-class:: interim-class

.. class:: StreamCollection.signals
   :no-index:
   

   .. method:: stream_notify(prop_stream: ~gi.repository.Gst.Stream, prop: ~gi.repository.GObject.ParamSpec) -> None

      The stream notify signal is used to be notified of property changes to
      streams within the collection.







      :param prop_stream: the :obj:`~gi.repository.Gst.Stream` that originated the signal


      :param prop: the property that changed









Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: StreamCollection
   :no-index:
   

   .. method:: do_stream_notify(stream: ~gi.repository.Gst.Stream, pspec: ~gi.repository.GObject.ParamSpec) -> None

      default signal handler for the stream-notify signal







      :param stream: 

      :param pspec: 








Fields
------

.. rst-class:: interim-class

.. class:: StreamCollection
   :no-index:
   

   .. attribute:: object

      






   .. attribute:: priv

      






   .. attribute:: upstream_id