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

This class represent a mixed remote stream. More...

#include <owt/conference/remotemixedstream.h>

Inheritance diagram for owt::conference::RemoteMixedStream:
Collaboration diagram for owt::conference::RemoteMixedStream:

Public Member Functions

void AddObserver (RemoteMixedStreamObserver &observer)
 Add an observer for conferenc client.
 
void RemoveObserver (RemoteMixedStreamObserver &observer)
 Remove an object from conference client.
 
std::string Viewport ()
 Returns an attribute of mixed streams which distinguishes them from other mixed streams a conference room provides. More...
 
- Public Member Functions inherited from owt::base::RemoteStream
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 represent a mixed remote stream.

Member Function Documentation

◆ Viewport()

std::string owt::conference::RemoteMixedStream::Viewport ( )

Returns an attribute of mixed streams which distinguishes them from other mixed streams a conference room provides.

A conference room, since Intel CS for WebRTC v3.4 and later, has been extended to support multiple presentations of the mixed audio and video for variant purposes. For example, in remote education scenario, the teacher and students may subscribe different mixed streams with view of 'teacher' and 'student' respectively in the same class conference room. It is also the label of a mixed stream indicating its peculiarity with a meaningful string-typed value, which must be unique within a room.