skyway::room::interface::LocalRoomMember クラス

LocalRoomMemberの操作を行うインターフェース [詳解]

#include <local_room_member.hpp>

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

クラス
class	EventListener
	イベントリスナ [詳解]
struct	PublicationOptions
	Publish時の設定 [詳解]
struct	SubscriptionOptions
	Subscribe時の設定 [詳解]

公開メンバ関数
virtual void	AddEventListener (EventListener *listener)=0
	イベントの購読します。
virtual void	RemoveEventListener (EventListener *listener)=0
	イベントの購読を中止します。
virtual std::unique_ptr< RoomPublication >	Publish (std::shared_ptr< core::interface::LocalStream >, PublicationOptions options)=0
	LocalStreamを公開します。
virtual std::unique_ptr< RoomSubscription >	Subscribe (const std::string &publication_id, SubscriptionOptions options)=0
	公開されているPublicationを購読します。
virtual bool	Unpublish (const std::string &publication_id)=0
	公開しているPublicationを非公開にします。
virtual bool	Unsubscribe (const std::string &subscription_id)=0
	購読しているSubscriptionの購読を解除します。
基底クラス skyway::room::interface::RoomMember に属する継承公開メンバ関数
virtual boost::optional< std::string >	RoomId ()=0
	このMemberに紐づくRoomのIdを取得します。
virtual boost::optional< std::string >	RoomName ()=0
	このMemberに紐づくRoomのNameを取得します。
virtual std::string	Id ()=0
	Idを取得します。
virtual boost::optional< std::string >	Name ()=0
	Nameを取得します。
virtual boost::optional< std::string >	Metadata ()=0
	Metadataを取得します。
virtual model::MemberType	Type ()=0
	Typeを取得します。
virtual std::string	Subtype ()=0
	SubTypeを取得します。
virtual model::Side	Side ()=0
	Sideを取得します。
virtual core::interface::MemberState	State ()=0
	Stateを取得します。
virtual std::vector< std::unique_ptr< RoomPublication > >	Publications ()=0
	このMemberのPublication一覧を取得します。
virtual std::vector< std::unique_ptr< RoomSubscription > >	Subscriptions ()=0
	このMemberのSubscription一覧を取得します。
virtual bool	UpdateMetadata (const std::string &metadata)=0
	Metadataを更新します。
virtual bool	Leave ()=0
	Roomから退室します。

詳解

LocalRoomMemberの操作を行うインターフェース

関数詳解

AddEventListener()

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

pure virtual

イベントの購読します。

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

Publish()

virtual std::unique_ptr< RoomPublication > skyway::room::interface::LocalRoomMember::Publish ( std::shared_ptr< core::interface::LocalStream >  , PublicationOptions  options  )

pure virtual

LocalStreamを公開します。

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

RemoveEventListener()

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

pure virtual

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

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

Subscribe()

virtual std::unique_ptr< RoomSubscription > skyway::room::interface::LocalRoomMember::Subscribe ( const std::string &  publication_id, SubscriptionOptions  options  )

pure virtual

公開されているPublicationを購読します。

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

Unpublish()

virtual bool skyway::room::interface::LocalRoomMember::Unpublish ( const std::string &  publication_id )

pure virtual

公開しているPublicationを非公開にします。

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

Unsubscribe()

virtual bool skyway::room::interface::LocalRoomMember::Unsubscribe ( const std::string &  subscription_id )

pure virtual

購読しているSubscriptionの購読を解除します。

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

---

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

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