zao::endpoint::video::NvSourceInterface Class Reference

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

#include <NvSourceInterface.hpp>

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

Public Member Functions
virtual void	SetAcceptableFormats (const std::vector< VideoFormat > &formats)=0
	送信可能なフォーマット一覧を提示する。
virtual bool	GetDecidedFormat (VideoFormat &format) const noexcept=0
	決定したフォーマットを取得する。
virtual std::shared_future< VideoFormat >	GetFormatDecisionStatus () 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	RegisterCallback (const std::shared_ptr< NvSourceCallbackInterface > &listener, bool use_weak_ptr=false)=0
	コールバックの送信先をshared_ptrまたはweak_ptrで登録する
virtual void	RegisterCallback (std::unique_ptr< NvSourceCallbackInterface > &&listener)=0
	コールバックの送信先をunique_ptrで登録する
virtual void	SetTimestamp (const std::shared_ptr< TimestampInterface > &timestamp)=0
	このストリームで用いるタイムスタンプを設定する。
virtual bool	GetStopSupplyStatus () const noexcept=0
	データ供給抑制状態を取得する。

Detailed Description

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

Member Function Documentation

GetDecidedFormat()

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

pure virtualnoexcept

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

Parameters

format

フォーマットの格納先

Return values

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

GetFormatDecisionStatus()

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

pure virtualnoexcept

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

Note

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

Returns

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

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/2]

virtual void zao::endpoint::video::NvSourceInterface::RegisterCallback ( const std::shared_ptr< NvSourceCallbackInterface > &  listener, bool  use_weak_ptr = false  )

pure virtual

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

Note

参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。

有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。

Parameters

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

RegisterCallback() [2/2]

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

pure virtual

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

Note

参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。

有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。

Parameters

listener

送信先への参照

SendStatistics()

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

pure virtual

統計情報の送信

SetAcceptableFormats()

virtual void zao::endpoint::video::NvSourceInterface::SetAcceptableFormats ( 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/J2310.zao_sdk_jetson.build/zep_sdk/libzao-endpoint/include/zao/endpoint/video/NvSourceInterface.hpp