skyway::room::RoomPublication クラス

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

#include <room_publication.hpp>

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

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

詳解

RoomPublicationの操作を行うクラス

構築子と解体子

~RoomPublication()

skyway::room::RoomPublication::~RoomPublication ( )

virtual

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

関数詳解

AddEventListener()

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

overridevirtual

イベントを購読します。

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

Cancel()

bool skyway::room::RoomPublication::Cancel ( )

overridevirtual

Publishを中止します。

非推奨:

本機能は非推奨です。

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

CodecCapabilities()

std::vector< model::Codec > skyway::room::RoomPublication::CodecCapabilities ( )

overridevirtual

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

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

ContentType()

model::ContentType skyway::room::RoomPublication::ContentType ( )

overridevirtual

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

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

Disable()

bool skyway::room::RoomPublication::Disable ( )

overridevirtual

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

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

Enable()

bool skyway::room::RoomPublication::Enable ( )

overridevirtual

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

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

Encodings()

std::vector< model::Encoding > skyway::room::RoomPublication::Encodings ( )

overridevirtual

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

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

GetStats()

std::optional< model::WebRTCStats > skyway::room::RoomPublication::GetStats ( const std::string &  selector )

overridevirtual

統計情報を取得します。

非推奨:

本機能は非推奨です。

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

引数

selector

取得対象のmemberID

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

Id()

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

overridevirtual

Idを取得します。

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

Metadata()

std::optional< std::string > skyway::room::RoomPublication::Metadata ( )

overridevirtual

Metadataを取得します。

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

Publisher()

std::shared_ptr< interface::RoomMember > skyway::room::RoomPublication::Publisher ( )

overridevirtual

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

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

RemoveEventListener()

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

overridevirtual

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

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

ReplaceStream()

bool skyway::room::RoomPublication::ReplaceStream ( std::shared_ptr< core::interface::LocalStream >  stream )

overridevirtual

公開しているStreamを変更します。

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

State()

core::interface::PublicationState skyway::room::RoomPublication::State ( )

overridevirtual

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

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

Stream()

std::shared_ptr< core::interface::LocalStream > skyway::room::RoomPublication::Stream ( )

overridevirtual

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

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

Subscriptions()

std::vector< std::shared_ptr< interface::RoomSubscription > > skyway::room::RoomPublication::Subscriptions ( )

overridevirtual

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

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

UpdateEncodings()

bool skyway::room::RoomPublication::UpdateEncodings ( std::vector< model::Encoding >  encodings )

overridevirtual

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

この機能はRTP映像入力モードでは機能しません。

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

UpdateMetadata()

bool skyway::room::RoomPublication::UpdateMetadata ( const std::string &  metadata )

overridevirtual

Metadataを更新します。

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

---

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

• include/skyway/room/room_publication.hpp