skyway::core::interface::Publication クラス

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

#include <publication.hpp>

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

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

公開メンバ関数
virtual void	AddEventListener (EventListener *listener)=0
	イベントを購読します。
virtual void	RemoveEventListener (EventListener *listener)=0
	イベントの購読を中止します。
virtual std::string	Id () const =0
	Idを取得します。
virtual MemberInterface *	Publisher () const =0
	このPublicationをPublishしているMemberを取得します。
virtual std::vector< Subscription * >	Subscriptions () const =0
	このPublicationを購読しているSubsciptionの一覧を取得します。
virtual model::ContentType	ContentType () const =0
	ContentType(VideoかAudioかDataか)を取得します。
virtual boost::optional< std::string >	Metadata () const =0
	Metadataを取得します。
virtual Publication *	Origin () const =0
	このPublicationのOriginを取得します。
virtual std::vector< model::Codec >	CodecCapabilities () const =0
	このPublicationのコーデック一覧を取得します。
virtual std::vector< model::Encoding >	Encodings () const =0
	このPublicationのエンコーディング設定の一覧を取得します。
virtual PublicationState	State ()=0
	State(公開状態がEnableかDisabelかCancelか)を取得します。
virtual std::shared_ptr< LocalStream >	Stream () const =0
	Publisherが持つStreamを取得します。
virtual bool	UpdateMetadata (const std::string &metadata)=0
	Metadataを更新します。
virtual void	UpdateEncodings (std::vector< model::Encoding > encodings)=0
	エンコーディング設定を更新します。
virtual bool	ReplaceStream (std::shared_ptr< LocalStream > stream)=0
	公開しているStreamを変更します。
virtual bool	Cancel () const =0
	Publishを中止します。
virtual bool	Enable ()=0
	Publicationの公開を開始します。disableによって停止していた場合は再開します。
virtual bool	Disable () const =0
	Publicationの公開を一時停止します。
virtual boost::optional< model::WebRTCStats >	GetStats (const std::string &selector)=0
	統計情報を取得します。

詳解

Publicationのインターフェース

関数詳解

AddEventListener()

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

pure virtual

イベントを購読します。

引数

listener

イベントリスナ

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

Cancel()

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

pure virtual

Publishを中止します。

非推奨:

本機能は非推奨です。

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

CodecCapabilities()

virtual std::vector< model::Codec > skyway::core::interface::Publication::CodecCapabilities ( ) const

pure virtual

このPublicationのコーデック一覧を取得します。

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

ContentType()

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

pure virtual

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

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

Disable()

virtual bool skyway::core::interface::Publication::Disable ( ) const

pure virtual

Publicationの公開を一時停止します。

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

Enable()

virtual bool skyway::core::interface::Publication::Enable ( )

pure virtual

Publicationの公開を開始します。disableによって停止していた場合は再開します。

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

Encodings()

virtual std::vector< model::Encoding > skyway::core::interface::Publication::Encodings ( ) const

pure virtual

このPublicationのエンコーディング設定の一覧を取得します。

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

GetStats()

virtual boost::optional< model::WebRTCStats > skyway::core::interface::Publication::GetStats ( const std::string &  selector )

pure virtual

統計情報を取得します。

非推奨:

本機能は非推奨です。

引数

selector

取得対象のmemberID

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

Id()

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

pure virtual

Idを取得します。

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

Metadata()

virtual boost::optional< std::string > skyway::core::interface::Publication::Metadata ( ) const

pure virtual

Metadataを取得します。

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

Origin()

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

pure virtual

このPublicationのOriginを取得します。

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

Publisher()

virtual MemberInterface * skyway::core::interface::Publication::Publisher ( ) const

pure virtual

このPublicationをPublishしているMemberを取得します。

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

RemoveEventListener()

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

pure virtual

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

引数

listener

対象のイベントリスナ

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

State()

virtual PublicationState skyway::core::interface::Publication::State ( )

pure virtual

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

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

Stream()

virtual std::shared_ptr< LocalStream > skyway::core::interface::Publication::Stream ( ) const

pure virtual

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

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

Subscriptions()

virtual std::vector< Subscription * > skyway::core::interface::Publication::Subscriptions ( ) const

pure virtual

このPublicationを購読しているSubsciptionの一覧を取得します。

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

UpdateEncodings()

virtual void skyway::core::interface::Publication::UpdateEncodings ( std::vector< model::Encoding >  encodings )

pure virtual

エンコーディング設定を更新します。

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

UpdateMetadata()

virtual bool skyway::core::interface::Publication::UpdateMetadata ( const std::string &  metadata )

pure virtual

Metadataを更新します。

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

---

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

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