NVIDIA Multimedia APIを利用した映像ソース機能インターフェース More...

#include <NvSourceInterface.hpp>

Collaboration diagram for zao::endpoint::video::NvSourceInterface:

[legend]

Public Member Functions
void	SetAcceptableFormats (const std::vector< VideoFormat > &formats)
	映像ソースとして送信可能なフォーマット一覧を提示する。

virtual void	SetSourceFormats (const std::vector< VideoFormat > &formats)=0
	映像ソースとして送信可能なフォーマット一覧を提示する。

bool	GetDecidedFormat (VideoFormat &format) const noexcept
	決定したフォーマットを取得する。

virtual bool	GetDeterminedFormat (VideoFormat &format) const noexcept=0
	決定したフォーマットを取得する。

std::shared_future< VideoFormat >	GetFormatDecisionStatus () const noexcept
	フォーマット決定状態を取得するshared_futureを取得する。

virtual std::shared_future< VideoFormat >	GetDeterminedFormatAsync () const noexcept=0
	フォーマット決定状態を取得するshared_futureを取得する。

virtual std::unique_ptr< NvBufferInterface >	DequeueBuffer ()=0
	画像を供給するためのバッファを取得する

virtual bool	QueueBuffer (std::unique_ptr< NvBufferInterface > buffer)=0
	送信する画像を供給する

virtual void	SendStatistics ()=0
	統計情報の送信

virtual void	SetTimestamp (const std::shared_ptr< TimestampInterface > &timestamp)=0
	このストリームで用いるタイムスタンプを設定する。

virtual bool	GetStopSupplyStatus () const noexcept=0
	データ供給抑制状態を取得する。

void	RegisterCallback (const std::shared_ptr< NvSourceCallbackInterface > &listener, bool use_weak_ptr)
	コールバックの送信先をshared_ptrまたはweak_ptrで登録する

virtual void	RegisterCallback (const std::shared_ptr< NvSourceCallbackInterface > &listener)=0
	コールバックの送信先をshared_ptrで登録する

virtual void	RegisterCallback (const std::weak_ptr< NvSourceCallbackInterface > &listener_weak, StoreAsWeakPtrType)=0
	コールバックの送信先をweak_ptrで登録する

virtual void	RegisterCallback (std::unique_ptr< NvSourceCallbackInterface > &&listener)=0
	コールバックの送信先をunique_ptrで登録する

Detailed Description

NVIDIA Multimedia APIを利用した映像ソース機能インターフェース

Member Function Documentation

◆ GetDecidedFormat()

bool zao::endpoint::video::NvSourceInterface::GetDecidedFormat ( VideoFormat & format ) const

inlinenoexcept

決定したフォーマットを取得する。

Parameters

format フォーマットの格納先

Return values

true	フォーマットが決定している(formatの内容が有効)
false	フォーマットは未決定である(formatの内容は無効)

Deprecated:: 代わりに GetDeterminedFormat を用いてください。

◆ GetDeterminedFormat()

virtual bool zao::endpoint::video::NvSourceInterface::GetDeterminedFormat ( VideoFormat & format ) const

pure virtualnoexcept

決定したフォーマットを取得する。

Parameters

format フォーマットの格納先

Return values

true	フォーマットが決定している(formatの内容が有効)
false	フォーマットは未決定である(formatの内容は無効)

◆ GetDeterminedFormatAsync()

virtual std::shared_future< VideoFormat > zao::endpoint::video::NvSourceInterface::GetDeterminedFormatAsync ( ) const

pure virtualnoexcept

フォーマット決定状態を取得するshared_futureを取得する。

Note: 既にフォーマット決定済みの場合、準備完了状態のオブジェクトを返却する。

Returns: フォーマット決定時にそのフォーマットを返却する shared_futureオブジェクト

◆ GetFormatDecisionStatus()

std::shared_future< VideoFormat > zao::endpoint::video::NvSourceInterface::GetFormatDecisionStatus ( ) const

inlinenoexcept

フォーマット決定状態を取得するshared_futureを取得する。

Note: 既にフォーマット決定済みの場合、準備完了状態のオブジェクトを返却する。

Returns: フォーマット決定時にそのフォーマットを返却する shared_futureオブジェクト

Deprecated:: 代わりに GetDeterminedFormatAsync を用いてください。

◆ GetStopSupplyStatus()

virtual bool zao::endpoint::SourceStreamInterface::GetStopSupplyStatus ( ) const

pure virtualnoexceptinherited

データ供給抑制状態を取得する。

Return values

true	データ供給抑制が要求されている。
false	データ供給抑制が要求されていない。

◆ QueueBuffer()

virtual bool zao::endpoint::video::NvSourceInterface::QueueBuffer ( std::unique_ptr< NvBufferInterface > buffer )

pure virtual

送信する画像を供給する

Note: DequeueBuffer() で取得したバッファ以外を渡してはならない

◆ RegisterCallback() [1/4]

virtual void zao::endpoint::EventSourceInterface< NvSourceCallbackInterface >::RegisterCallback ( const std::shared_ptr< NvSourceCallbackInterface > & listener )

pure virtualinherited

コールバックの送信先をshared_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener 送信先への参照

◆ RegisterCallback() [2/4]

void zao::endpoint::EventSourceInterface< NvSourceCallbackInterface >::RegisterCallback	(	const std::shared_ptr< NvSourceCallbackInterface > &	listener,
		bool	use_weak_ptr
	)

inlineinherited

コールバックの送信先をshared_ptrまたはweak_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener	送信先への参照
use_weak_ptr	weak_ptrとして保持する場合にtrueを指定

Deprecated:: この関数は将来廃止予定です。 RegisterCallback(const std::shared_ptr<T>&) または RegisterCallback(const std::weak_ptr<T>&, StoreAsWeakPtrType) を使用してください。

◆ RegisterCallback() [3/4]

virtual void zao::endpoint::EventSourceInterface< NvSourceCallbackInterface >::RegisterCallback	(	const std::weak_ptr< NvSourceCallbackInterface > &	listener_weak,
		StoreAsWeakPtrType
	)

pure virtualinherited

コールバックの送信先をweak_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener_weak 送信先への参照(所有権を持たない)

◆ RegisterCallback() [4/4]

virtual void zao::endpoint::EventSourceInterface< NvSourceCallbackInterface >::RegisterCallback ( std::unique_ptr< NvSourceCallbackInterface > && listener )

pure virtualinherited

コールバックの送信先をunique_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener 送信先への参照

◆ SendStatistics()

virtual void zao::endpoint::video::NvSourceInterface::SendStatistics ( )

pure virtual

統計情報の送信

◆ SetAcceptableFormats()

void zao::endpoint::video::NvSourceInterface::SetAcceptableFormats ( const std::vector< VideoFormat > & formats )

inline

映像ソースとして送信可能なフォーマット一覧を提示する。

Parameters

formats 送信可能なフォーマットの配列

Deprecated:: 代わりに SetSourceFormats を用いてください。

◆ SetSourceFormats()

virtual void zao::endpoint::video::NvSourceInterface::SetSourceFormats ( const std::vector< VideoFormat > & formats )

pure virtual

映像ソースとして送信可能なフォーマット一覧を提示する。

Parameters

formats 送信可能なフォーマットの配列

◆ SetTimestamp()

virtual void zao::endpoint::StreamInterface::SetTimestamp ( const std::shared_ptr< TimestampInterface > & timestamp )

pure virtualinherited

このストリームで用いるタイムスタンプを設定する。

Parameters

timestamp タイムスタンプ管理オブジェクト

The documentation for this class was generated from the following file:

/home/jenkins/workspace/J2408.zao_sdk_jetson.build/zep_sdk/libzao-endpoint/include/zao/endpoint/video/NvSourceInterface.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetDecidedFormat()

◆ GetDeterminedFormat()

◆ GetDeterminedFormatAsync()

◆ GetFormatDecisionStatus()

◆ GetStopSupplyStatus()

◆ QueueBuffer()

◆ RegisterCallback() [1/4]

◆ RegisterCallback() [2/4]

◆ RegisterCallback() [3/4]

◆ RegisterCallback() [4/4]

◆ SendStatistics()

◆ SetAcceptableFormats()

◆ SetSourceFormats()

◆ SetTimestamp()