skyway::core::interface::Subscription クラス

Subscriptionのインターフェース [詳解]

#include <subscription.hpp>

skyway::core::interface::Subscription の継承関係図

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

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

詳解

Subscriptionのインターフェース

関数詳解

AddEventListener()

virtual void skyway::core::interface::Subscription::AddEventListener ( EventListener *  listener )

pure virtual

イベントを購読します。

引数

listener

イベントリスナ

skyway::core::Subscriptionで実装されています。

Cancel()

virtual bool skyway::core::interface::Subscription::Cancel ( ) const

pure virtual

Subscribeを中止します。

非推奨:

本機能は非推奨です。

skyway::core::Subscriptionで実装されています。

ChangePreferredEncoding()

virtual void skyway::core::interface::Subscription::ChangePreferredEncoding ( const std::string &  id )

pure virtual

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

skyway::core::Subscriptionで実装されています。

ContentType()

virtual model::ContentType skyway::core::interface::Subscription::ContentType ( ) const

pure virtual

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

skyway::core::Subscriptionで実装されています。

GetStats()

virtual boost::optional< model::WebRTCStats > skyway::core::interface::Subscription::GetStats ( )

pure virtual

統計情報を取得します。

非推奨:

本機能は非推奨です。

skyway::core::Subscriptionで実装されています。

Id()

virtual std::string skyway::core::interface::Subscription::Id ( ) const

pure virtual

Idを取得します。

skyway::core::Subscriptionで実装されています。

PreferredEncodingId()

virtual boost::optional< std::string > skyway::core::interface::Subscription::PreferredEncodingId ( ) const

pure virtual

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

skyway::core::Subscriptionで実装されています。

Publication()

virtual Publication * skyway::core::interface::Subscription::Publication ( ) const

pure virtual

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

skyway::core::Subscriptionで実装されています。

RemoveEventListener()

virtual void skyway::core::interface::Subscription::RemoveEventListener ( EventListener *  listener )

pure virtual

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

引数

listener

対象のイベントリスナ

skyway::core::Subscriptionで実装されています。

State()

virtual SubscriptionState skyway::core::interface::Subscription::State ( )

pure virtual

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

skyway::core::Subscriptionで実装されています。

Stream()

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

pure virtual

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

LocalPerson.subscribeの返り値でSubscriptionを入手した場合、入手時点で値がsetされています。 その他、イベントの発火によってSubscriptionを取得した場合、まだ値がsetされていない可能性があります。

skyway::core::Subscriptionで実装されています。

Subscriber()

virtual Member * skyway::core::interface::Subscription::Subscriber ( ) const

pure virtual

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

skyway::core::Subscriptionで実装されています。

---

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

• include/skyway/core/interface/subscription.hpp