Zao SDK for Jetson / libzao-endpoint API リファレンス 1.6.0.0 (2024-12-24)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
zao::endpoint::video::NvSourceInterface Class Referenceabstract

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

#include <NvSourceInterface.hpp>

Collaboration diagram for zao::endpoint::video::NvSourceInterface:
Collaboration graph
[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
 決定したフォーマットを取得する。
 
virtual bool GetDeterminedFormat (VideoFormat &format) const =0
 決定したフォーマットを取得する。
 
std::shared_future< VideoFormatGetFormatDecisionStatus () const
 フォーマット決定状態を取得するshared_futureを取得する。
 
virtual std::shared_future< VideoFormatGetDeterminedFormatAsync () const =0
 フォーマット決定状態を取得するshared_futureを取得する。
 
virtual NvSourceBufferDequeueResult DequeueSourceBuffer ()=0
 画像を供給するためのバッファを取り出す。
 
std::unique_ptr< NvBufferInterfaceDequeueBuffer ()
 画像を供給するためのバッファを取得する
 
virtual NvSourceBufferEnqueueResult EnqueueSourceBuffer (std::unique_ptr< NvBufferInterface > buffer)=0
 送信する画像を格納したバッファをキューに入れる。
 
bool QueueBuffer (std::unique_ptr< NvBufferInterface > buffer)
 送信する画像を格納したバッファをキューに入れる。
 
virtual ~NvSourceInterface () noexcept=default
 NvSourceInterface オブジェクトを破棄する。
 
virtual void SetTimestamp (std::shared_ptr< TimestampInterface > timestamp)=0
 このストリームで用いるタイムスタンプを設定する。
 
virtual bool GetStopSupplyStatus () const noexcept=0
 データ供給抑制状態を取得する。
 
virtual void RegisterCallback (std::shared_ptr< NvSourceCallbackInterface > listener)=0
 コールバックの送信先をshared_ptrで登録する
 
virtual void RegisterCallback (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

◆ DequeueBuffer()

std::unique_ptr< NvBufferInterface > zao::endpoint::video::NvSourceInterface::DequeueBuffer ( )
inline

画像を供給するためのバッファを取得する

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

◆ DequeueSourceBuffer()

virtual NvSourceBufferDequeueResult zao::endpoint::video::NvSourceInterface::DequeueSourceBuffer ( )
pure virtual

画像を供給するためのバッファを取り出す。

Since
SDK1.5

◆ EnqueueSourceBuffer()

virtual NvSourceBufferEnqueueResult zao::endpoint::video::NvSourceInterface::EnqueueSourceBuffer ( std::unique_ptr< NvBufferInterface buffer)
pure virtual

送信する画像を格納したバッファをキューに入れる。

Since
SDK1.5
Parameters
buffer送信する画像を格納したバッファ。
Note
DequeueSourceBuffer で取得したバッファ以外を渡してはならない

◆ GetDecidedFormat()

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

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

Parameters
formatフォーマットの格納先
Return values
trueフォーマットが決定している(formatの内容が有効)
falseフォーマットは未決定である(formatの内容は無効)
Deprecated:
代わりに GetDeterminedFormat を用いてください。

◆ GetDeterminedFormat()

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

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

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

◆ GetDeterminedFormatAsync()

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

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

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

◆ GetFormatDecisionStatus()

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

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

Note
既にフォーマット決定済みの場合、 準備完了状態のオブジェクトを返却する。
Returns
フォーマット決定時にそのフォーマットを返却する shared_futureオブジェクト
Deprecated:
代わりに GetDeterminedFormatAsync を用いてください。

◆ GetStopSupplyStatus()

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

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

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

◆ QueueBuffer()

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

送信する画像を格納したバッファをキューに入れる。

Deprecated:
代わりに EnqueueSourceBuffer を用いてください。
Parameters
buffer送信する画像を格納したバッファ。
Note
DequeueSourceBuffer で取得したバッファ以外を渡してはならない

◆ RegisterCallback() [1/3]

virtual void zao::endpoint::EventSourceInterface< NvSourceCallbackInterface >::RegisterCallback ( std::shared_ptr< NvSourceCallbackInterface >  listener)
pure virtualinherited

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

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

◆ RegisterCallback() [2/3]

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送信先への参照

◆ RegisterCallback() [3/3]

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

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

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

◆ 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 ( std::shared_ptr< TimestampInterface timestamp)
pure virtualinherited

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

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

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