zep::NvSourceInterface Class Reference

Video source function interface using NVIDIA Multimedia API. More...

#include <NvSourceInterface.hpp>

Collaboration diagram for zep::NvSourceInterface:

Public Member Functions
virtual void	SetAcceptableFormats (const std::vector< VideoFormat > &formats)=0
	Present a list of formats that can be sent.
virtual bool	GetDecidedFormat (VideoFormat &format) const noexcept=0
	Get the determined formats.
virtual std::shared_future< VideoFormat >	GetFormatDecisionStatus () const noexcept=0
	Get shared_future to get the format decision status.
virtual std::unique_ptr< NvBufferInterface >	DequeueBuffer ()=0
virtual bool	QueueBuffer (std::unique_ptr< NvBufferInterface > buffer)=0
virtual void	SendStatistics ()=0
	Sending statistics.
virtual void	RegisterCallback (const std::shared_ptr< NvSourceCallbackInterface > &listener,. bool use_weak_ptr=false)=0
	Register a callback destination in shared_ptr or weak_ptr.
virtual void	RegisterCallback (std::unique_ptr< NvSourceCallbackInterface > &&listener)=0
	Register the callback destination with unique_ptr.
virtual void	SetTimestamp (const std::shared_ptr< TimestampInterface > &timestamp)=0
	Set the timestamp to be used for this stream.
virtual void	SetTimestamp (const std::shared_ptr< TimestampInterface > &timestamp)=0
	このストリームで用いるタイムスタンプを設定する。
virtual bool	GetStopSupplyStatus () const noexcept=0
	Get data supply suppression status.
virtual bool	GetStopSupplyStatus () const noexcept=0
	データ供給抑制状態を取得する。

Detailed Description

Video source function interface using NVIDIA Multimedia API.

Member Function Documentation

GetDecidedFormat()

virtual bool zep::NvSourceInterface::GetDecidedFormat ( VideoFormat &  format ) const

pure virtualnoexcept

Get the determined formats.

Parameters

format

Where formats are stored.

Return values

true	format is determined (content of format is valid)
false	format is undetermined (content of format is invalid)

GetFormatDecisionStatus()

virtual std::shared_future< VideoFormat > zep::NvSourceInterface::GetFormatDecisionStatus ( ) const

pure virtualnoexcept

Get shared_future to get the format decision status.

Note

If the format has already been decided, return an object in the ready state.

If the format has already been decided, return an object in the ready state.

Returns

shared_future to which the format is returned when the format is decided. object

GetStopSupplyStatus() [1/2]

virtual bool zep::SourceStreamInterface::GetStopSupplyStatus ( ) const

pure virtualnoexceptinherited

Get data supply suppression status.

Return values

true	Suppression of data supply is requested.
false	Suppression of data supply is not requested.

GetStopSupplyStatus() [2/2]

virtual bool zep::SourceStreamInterface::GetStopSupplyStatus ( ) const

pure virtualnoexceptinherited

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

Return values

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

RegisterCallback() [1/2]

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

pure virtual

Register a callback destination in shared_ptr or weak_ptr.

Note

Either shared_ptr/weak_ptr/unique_ptr can be used as a reference retention method.

Only one reference in total can be registered at the same time.

If a reference that does not hold a valid instance is passed, the destination is deleted.

Parameters

listener	Reference to destination
use_weak_ptr	Specify true when holding as weak_ptr

RegisterCallback() [2/2]

virtual void zep::NvSourceInterface::RegisterCallback ( std::unique_ptr< NvSourceCallbackInterface > &&  listener )

pure virtual

Register the callback destination with unique_ptr.

Note

Any of shared_ptr/weak_ptr/unique_ptr can be used as a reference retention method.

Only one reference in total can be registered at the same time, although both shared_ptr/weak_ptr/unique_ptr are available.

If a reference that does not hold a valid instance is passed, the destination is deleted.

Parameters

listener

Reference to destination

SendStatistics()

virtual void zep::NvSourceInterface::SendStatistics ( )

pure virtual

Sending statistics.

SetAcceptableFormats()

virtual void zep::NvSourceInterface::SetAcceptableFormats ( const std::vector< VideoFormat > &  formats )

pure virtual

Present a list of formats that can be sent.

Parameters

formats

Array of formats that can be sent.

SetTimestamp() [1/2]

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

pure virtualinherited

Set the timestamp to be used for this stream.

Parameters

timestamp

timestamp management object.

SetTimestamp() [2/2]

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

pure virtualinherited

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

Parameters

timestamp

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

---

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

• /Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep-en/video/NvSourceInterface.hpp