skyway::core::Subscription クラス

Subscriptionの実装クラス [詳解]

#include <subscription.hpp>

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

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

詳解

Subscriptionの実装クラス

関数詳解

AddEventListener()

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

overridevirtual

イベントを購読します。

引数

listener

イベントリスナ

skyway::core::interface::Subscriptionを実装しています。

Cancel()

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

overridevirtual

Subscribeを中止します。

非推奨:

本機能は非推奨です。

skyway::core::interface::Subscriptionを実装しています。

ChangePreferredEncoding()

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

overridevirtual

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

skyway::core::interface::Subscriptionを実装しています。

ContentType()

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

overridevirtual

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

skyway::core::interface::Subscriptionを実装しています。

GetStats()

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

overridevirtual

統計情報を取得します。

非推奨:

本機能は非推奨です。

skyway::core::interface::Subscriptionを実装しています。

Id()

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

overridevirtual

Idを取得します。

skyway::core::interface::Subscriptionを実装しています。

PreferredEncodingId()

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

overridevirtual

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

skyway::core::interface::Subscriptionを実装しています。

Publication()

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

overridevirtual

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

skyway::core::interface::Subscriptionを実装しています。

RemoveEventListener()

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

overridevirtual

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

引数

listener

対象のイベントリスナ

skyway::core::interface::Subscriptionを実装しています。

State()

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

overridevirtual

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

skyway::core::interface::Subscriptionを実装しています。

Stream()

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

overridevirtual

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

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

skyway::core::interface::Subscriptionを実装しています。

Subscriber()

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

overridevirtual

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

skyway::core::interface::Subscriptionを実装しています。

---

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

• include/skyway/core/subscription.hpp