skyway::core::Publication クラス

Publicationの実装クラス [詳解]

#include <publication.hpp>

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

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

詳解

Publicationの実装クラス

構築子と解体子

~Publication()

skyway::core::Publication::~Publication ( )

virtual

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

関数詳解

AddEventListener()

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

overridevirtual

イベントを購読します。

引数

listener

イベントリスナ

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

Cancel()

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

overridevirtual

Publishを中止します。

非推奨:

本機能は非推奨です。

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

CodecCapabilities()

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

overridevirtual

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

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

ContentType()

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

overridevirtual

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

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

Disable()

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

overridevirtual

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

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

Enable()

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

overridevirtual

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

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

Encodings()

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

overridevirtual

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

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

GetStats()

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

overridevirtual

統計情報を取得します。

非推奨:

本機能は非推奨です。

引数

selector

取得対象のmemberID

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

Id()

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

overridevirtual

Idを取得します。

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

Metadata()

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

overridevirtual

Metadataを取得します。

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

Origin()

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

overridevirtual

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

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

Publisher()

interface::Member * skyway::core::Publication::Publisher ( ) const

overridevirtual

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

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

RemoveEventListener()

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

overridevirtual

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

引数

listener

対象のイベントリスナ

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

State()

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

overridevirtual

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

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

Stream()

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

overridevirtual

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

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

Subscriptions()

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

overridevirtual

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

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

UpdateEncodings()

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

overridevirtual

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

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

UpdateMetadata()

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

overridevirtual

Metadataを更新します。

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

---

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

• include/skyway/core/publication.hpp