Intel® Collaboration Suite for WebRTC  version 4.3.1
Open WebRTC Toolkit (OWT) Client SDK for Windows*
owt::base::RemoteStream Class Reference

This class represents a remote stream. More...

#include <owt/base/stream.h>

Inheritance diagram for owt::base::RemoteStream:
Collaboration diagram for owt::base::RemoteStream:

Public Member Functions

std::string Origin ()
 
SubscriptionCapabilities Capabilities ()
 Get the subscription capabilities on the stream.
 
PublicationSettings Settings ()
 Get the publication settings of the stream.
 
void Stop ()
 Stop the remote stream.
 
virtual const std::unordered_map< std::string, std::string > Attributes () const
 Returns a user-defined attribute map. More...
 
- Public Member Functions inherited from owt::base::Stream
 Stream (MediaStreamInterface *media_stream, StreamSourceInfo source)
 
virtual std::string Id () const
 Get the ID of the stream. More...
 
virtual void DisableAudio ()
 Disable all audio tracks of the stream.
 
virtual void DisableVideo ()
 Disable all video tracks of the stream.
 
virtual void EnableAudio ()
 Enable all audio tracks of the stream.
 
virtual void EnableVideo ()
 Enable all video tracks of the stream.
 
virtual const std::unordered_map< std::string, std::string > Attributes () const
 Returns a user-defined attribute map. More...
 
virtual StreamSourceInfo Source () const
 Returns the audio/video source info of the stream. More...
 
virtual void AttachVideoRenderer (VideoRendererInterface &renderer)
 
virtual void AttachVideoRenderer (VideoRenderWindow &render_window)
 
virtual void AttachAudioPlayer (AudioPlayerInterface &player)
 
virtual void DetachVideoRenderer ()
 Detach the stream from its renderer.
 
virtual void DetachAudioPlayer ()
 Detach the stream from the audio player.
 
void AddObserver (StreamObserver &observer)
 Register an observer on the stream.
 
void RemoveObserver (StreamObserver &observer)
 De-Register an observer on the stream.
 

Detailed Description

This class represents a remote stream.

A remote is published from a remote client or MCU. Do not construct remote stream outside SDK.

Member Function Documentation

◆ Attributes()

virtual const std::unordered_map<std::string, std::string> owt::base::Stream::Attributes
inline

Returns a user-defined attribute map.

These attributes are defined by publisher. P2P mode always return empty map because it is not supported yet.

◆ Origin()

std::string owt::base::RemoteStream::Origin ( )

Return the remote user ID, indicates who published this stream. If it's mixed stream, origin will be "mcu".