skyway::room::RoomSubscription クラス

RoomSubscriptionの操作を行うクラス [詳解]

#include <room_subscription.hpp>

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

公開メンバ関数
	RoomSubscription (core::interface::Subscription *core, interface::RoomDomainFactory *factory)
std::string	Id () override
	Idを取得します。
model::ContentType	ContentType () override
	ContentType(VideoかAudioかDataか)を取得します。
std::unique_ptr< interface::RoomPublication >	Publication () override
	このSubscriptionに紐づくPublicationを取得します。
std::unique_ptr< interface::RoomMember >	Subscriber () override
	このSubscriptionを購読しているMemberを取得します。
core::interface::SubscriptionState	State () override
	State(公開状態がEnableかDisabelかCancelか)を取得します。
std::shared_ptr< core::interface::RemoteStream >	Stream () override
	Publisherが持つStreamを取得します。
boost::optional< std::string >	PreferredEncodingId () override
	このSubscriptionの優先エンコーディングIDを取得します。
void	AddEventListener (interface::RoomSubscription::EventListener *listener) override
	イベントを購読します。
void	RemoveEventListener (interface::RoomSubscription::EventListener *listener) override
	イベントの購読を中止します。
void	ChangePreferredEncoding (const std::string &id) override
	受信するエンコード設定を切り替えます。
bool	Cancel () override
	Subscribeを中止します。
boost::optional< model::WebRTCStats >	GetStats () override
	統計情報を取得します。
基底クラス skyway::core::interface::Subscription::EventListener に属する継承公開メンバ関数
virtual void	OnEnabled ()
	このSubscriptionの通信が有効になった時に発火するイベント。 Publication.Enableが実行された時に発火します。
virtual void	OnDisabled ()
	このSubscriptionの通信が無効になった時に発火するイベント。 Publication.Disableが実行された時に発火します。
virtual void	OnConnectionStateChanged (const ConnectionState state)
	このSubscriptionのメディア通信の状態が変化した時に発火するイベント

詳解

RoomSubscriptionの操作を行うクラス

構築子と解体子

~RoomSubscription()

skyway::room::RoomSubscription::~RoomSubscription ( )

virtual

skyway::room::interface::RoomSubscriptionを再実装しています。

関数詳解

AddEventListener()

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

overridevirtual

イベントを購読します。

skyway::room::interface::RoomSubscriptionを実装しています。

Cancel()

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

overridevirtual

Subscribeを中止します。

非推奨:

本機能は非推奨です。

skyway::room::interface::RoomSubscriptionを実装しています。

ChangePreferredEncoding()

void skyway::room::RoomSubscription::ChangePreferredEncoding ( const std::string &  id )

overridevirtual

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

skyway::room::interface::RoomSubscriptionを実装しています。

ContentType()

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

overridevirtual

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

skyway::room::interface::RoomSubscriptionを実装しています。

GetStats()

boost::optional< model::WebRTCStats > skyway::room::RoomSubscription::GetStats ( )

overridevirtual

統計情報を取得します。

非推奨:

本機能は非推奨です。

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

skyway::room::interface::RoomSubscriptionを実装しています。

Id()

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

overridevirtual

Idを取得します。

skyway::room::interface::RoomSubscriptionを実装しています。

PreferredEncodingId()

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

overridevirtual

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

skyway::room::interface::RoomSubscriptionを実装しています。

Publication()

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

overridevirtual

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

skyway::room::interface::RoomSubscriptionを実装しています。

RemoveEventListener()

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

overridevirtual

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

skyway::room::interface::RoomSubscriptionを実装しています。

State()

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

overridevirtual

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

skyway::room::interface::RoomSubscriptionを実装しています。

Stream()

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

overridevirtual

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

skyway::room::interface::RoomSubscriptionを実装しています。

Subscriber()

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

overridevirtual

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

skyway::room::interface::RoomSubscriptionを実装しています。

---

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

• include/skyway/room/room_subscription.hpp