skyway::room::interface::RoomSubscription クラス

RoomのSubscriptionを操作するインタフェース [詳解]

#include <room_subscription.hpp>

skyway::room::interface::RoomSubscription の継承関係図

クラス
class	EventListener
	イベントリスナ [詳解]

公開メンバ関数
virtual std::string	Id ()=0
	Idを取得します。
virtual model::ContentType	ContentType ()=0
	ContentType(VideoかAudioかDataか)を取得します。
virtual std::shared_ptr< RoomPublication >	Publication ()=0
	このSubscriptionに紐づくPublicationを取得します。
virtual std::shared_ptr< RoomMember >	Subscriber ()=0
	このSubscriptionを購読しているMemberを取得します。
virtual core::interface::SubscriptionState	State ()=0
	State(公開状態がEnableかDisabelかCancelか)を取得します。
virtual std::shared_ptr< core::interface::RemoteStream >	Stream ()=0
	Publisherが持つStreamを取得します。
virtual std::optional< std::string >	PreferredEncodingId ()=0
	このSubscriptionの優先エンコーディングIDを取得します。
virtual void	AddEventListener (EventListener *listener)=0
	イベントを購読します。
virtual void	RemoveEventListener (EventListener *listener)=0
	イベントの購読を中止します。
virtual bool	ChangePreferredEncoding (const std::string &id)=0
	受信するエンコード設定を切り替えます。
virtual bool	Cancel ()=0
	Subscribeを中止します。
virtual std::optional< model::WebRTCStats >	GetStats ()=0
	統計情報を取得します。

詳解

RoomのSubscriptionを操作するインタフェース

関数詳解

AddEventListener()

virtual void skyway::room::interface::RoomSubscription::AddEventListener ( EventListener *  listener )

pure virtual

イベントを購読します。

skyway::room::RoomSubscriptionで実装されています。

Cancel()

virtual bool skyway::room::interface::RoomSubscription::Cancel ( )

pure virtual

Subscribeを中止します。

非推奨:

本機能は非推奨です。

skyway::room::RoomSubscriptionで実装されています。

ChangePreferredEncoding()

virtual bool skyway::room::interface::RoomSubscription::ChangePreferredEncoding ( const std::string &  id )

pure virtual

受信するエンコード設定を切り替えます。

skyway::room::RoomSubscriptionで実装されています。

ContentType()

virtual model::ContentType skyway::room::interface::RoomSubscription::ContentType ( )

pure virtual

ContentType(VideoかAudioかDataか)を取得します。

skyway::room::RoomSubscriptionで実装されています。

GetStats()

virtual std::optional< model::WebRTCStats > skyway::room::interface::RoomSubscription::GetStats ( )

pure virtual

統計情報を取得します。

非推奨:

本機能は非推奨です。

試験的なAPIです。今後インターフェースや仕様が変更される可能性があります。

skyway::room::RoomSubscriptionで実装されています。

Id()

virtual std::string skyway::room::interface::RoomSubscription::Id ( )

pure virtual

Idを取得します。

skyway::room::RoomSubscriptionで実装されています。

PreferredEncodingId()

virtual std::optional< std::string > skyway::room::interface::RoomSubscription::PreferredEncodingId ( )

pure virtual

このSubscriptionの優先エンコーディングIDを取得します。

skyway::room::RoomSubscriptionで実装されています。

Publication()

virtual std::shared_ptr< RoomPublication > skyway::room::interface::RoomSubscription::Publication ( )

pure virtual

このSubscriptionに紐づくPublicationを取得します。

skyway::room::RoomSubscriptionで実装されています。

RemoveEventListener()

virtual void skyway::room::interface::RoomSubscription::RemoveEventListener ( EventListener *  listener )

pure virtual

イベントの購読を中止します。

skyway::room::RoomSubscriptionで実装されています。

State()

virtual core::interface::SubscriptionState skyway::room::interface::RoomSubscription::State ( )

pure virtual

State(公開状態がEnableかDisabelかCancelか)を取得します。

skyway::room::RoomSubscriptionで実装されています。

Stream()

virtual std::shared_ptr< core::interface::RemoteStream > skyway::room::interface::RoomSubscription::Stream ( )

pure virtual

Publisherが持つStreamを取得します。

skyway::room::RoomSubscriptionで実装されています。

Subscriber()

virtual std::shared_ptr< RoomMember > skyway::room::interface::RoomSubscription::Subscriber ( )

pure virtual

このSubscriptionを購読しているMemberを取得します。

skyway::room::RoomSubscriptionで実装されています。

---

このクラス詳解は次のファイルから抽出されました:

• include/skyway/room/interface/room_subscription.hpp