NVIDIA DeepStream SDK API Reference

9.1 Release
deepstream::AudioFrameMetadata Class Reference

Detailed Description

Holds information for a single audio frame.

Audio batches reuse NvDsBatchMeta::frame_meta_list, but the list entries are NvDsAudioFrameMeta instead of NvDsFrameMeta.

Definition at line 522 of file service-maker/includes/metadata.hpp.

Inheritance diagram for deepstream::AudioFrameMetadata:
Collaboration diagram for deepstream::AudioFrameMetadata:

Public Types

typedef std::unique_ptr< AbstractIterator< AudioFrameMetadata > > Iterator
 
typedef std::unique_ptr< AbstractIterator< AudioFrameMetadata > > Iterator
 

Public Member Functions

 AudioFrameMetadata (void *data=nullptr)
 Constructor through opaque data pointer. More...
 
virtual ~AudioFrameMetadata ()
 Destructor. More...
 
unsigned int iterate (const std::function< void(const ClassifierMetadata &)> &func) const
 Iterate the classifier metadata within it. More...
 
void initiateIterator (ClassifierMetadata::Iterator &) const
 Get the iterator for classifier metadata within it. More...
 
unsigned int iterate (const std::function< void(const UserMetadata &)> &func, int meta_type) const
 Iterate the user metadata within it. More...
 
void initiateIterator (UserMetadata::Iterator &, int meta_type) const
 Get the iterator for user metadata within it. More...
 
void append (const UserMetadata &)
 Append user metadata to the audio frame. More...
 
unsigned int padIndex () const
 Index of the pad from which the audio frame is generated. More...
 
unsigned int batchId () const
 Location the audio frame in the batch. More...
 
int frameNum () const
 Frame number. More...
 
unsigned int sourceId () const
 Identify the source of the frame, e.g. More...
 
int numSamplesPerFrame () const
 Number of samples in the audio frame. More...
 
unsigned int sampleRate () const
 Audio sample rate. More...
 
unsigned int numChannels () const
 Audio channel count. More...
 
int format () const
 Audio sample format. More...
 
int layout () const
 Audio channel layout. More...
 
uint64_t bufferPTS () const
 Holds the presentation timestamp (PTS) of the frame. More...
 
uint64_t ntpTimestamp () const
 Holds the ntp timestamp. More...
 
bool inferDone () const
 Whether inference was performed on the audio frame. More...
 
int classId () const
 Class id of the last classified event. More...
 
float confidence () const
 Confidence of the last classified event. More...
 
std::string classLabel () const
 Label of the last classified event. More...
 
 AudioFrameMetadata (void *data=nullptr)
 Constructor through opaque data pointer. More...
 
virtual ~AudioFrameMetadata ()
 Destructor. More...
 
unsigned int iterate (const std::function< void(const ClassifierMetadata &)> &func) const
 Iterate the classifier metadata within it. More...
 
void initiateIterator (ClassifierMetadata::Iterator &) const
 Get the iterator for classifier metadata within it. More...
 
unsigned int iterate (const std::function< void(const UserMetadata &)> &func, int meta_type) const
 Iterate the user metadata within it. More...
 
void initiateIterator (UserMetadata::Iterator &, int meta_type) const
 Get the iterator for user metadata within it. More...
 
void append (const UserMetadata &)
 Append user metadata to the audio frame. More...
 
unsigned int padIndex () const
 Index of the pad from which the audio frame is generated. More...
 
unsigned int batchId () const
 Location the audio frame in the batch. More...
 
int frameNum () const
 Frame number. More...
 
unsigned int sourceId () const
 Identify the source of the frame, e.g. More...
 
int numSamplesPerFrame () const
 Number of samples in the audio frame. More...
 
unsigned int sampleRate () const
 Audio sample rate. More...
 
unsigned int numChannels () const
 Audio channel count. More...
 
int format () const
 Audio sample format. More...
 
int layout () const
 Audio channel layout. More...
 
uint64_t bufferPTS () const
 Holds the presentation timestamp (PTS) of the frame. More...
 
uint64_t ntpTimestamp () const
 Holds the ntp timestamp. More...
 
bool inferDone () const
 Whether inference was performed on the audio frame. More...
 
int classId () const
 Class id of the last classified event. More...
 
float confidence () const
 Confidence of the last classified event. More...
 
std::string classLabel () const
 Label of the last classified event. More...
 
virtual operator bool ()
 operator to check if a metadata is void More...
 
virtual operator bool ()
 operator to check if a metadata is void More...
 

Protected Attributes

void * data_
 

Friends

class BatchMetadata
 

Member Typedef Documentation

◆ Iterator [1/2]

◆ Iterator [2/2]

Constructor & Destructor Documentation

◆ AudioFrameMetadata() [1/2]

deepstream::AudioFrameMetadata::AudioFrameMetadata ( void *  data = nullptr)

Constructor through opaque data pointer.

By default an empty audio frame metadata object is created.

◆ ~AudioFrameMetadata() [1/2]

virtual deepstream::AudioFrameMetadata::~AudioFrameMetadata ( )
virtual

Destructor.

◆ AudioFrameMetadata() [2/2]

deepstream::AudioFrameMetadata::AudioFrameMetadata ( void *  data = nullptr)

Constructor through opaque data pointer.

By default an empty audio frame metadata object is created.

◆ ~AudioFrameMetadata() [2/2]

virtual deepstream::AudioFrameMetadata::~AudioFrameMetadata ( )
virtual

Destructor.

Member Function Documentation

◆ append() [1/2]

void deepstream::AudioFrameMetadata::append ( const UserMetadata )

Append user metadata to the audio frame.

◆ append() [2/2]

void deepstream::AudioFrameMetadata::append ( const UserMetadata )

Append user metadata to the audio frame.

◆ batchId() [1/2]

unsigned int deepstream::AudioFrameMetadata::batchId ( ) const

Location the audio frame in the batch.

◆ batchId() [2/2]

unsigned int deepstream::AudioFrameMetadata::batchId ( ) const

Location the audio frame in the batch.

◆ bufferPTS() [1/2]

uint64_t deepstream::AudioFrameMetadata::bufferPTS ( ) const

Holds the presentation timestamp (PTS) of the frame.

◆ bufferPTS() [2/2]

uint64_t deepstream::AudioFrameMetadata::bufferPTS ( ) const

Holds the presentation timestamp (PTS) of the frame.

◆ classId() [1/2]

int deepstream::AudioFrameMetadata::classId ( ) const

Class id of the last classified event.

◆ classId() [2/2]

int deepstream::AudioFrameMetadata::classId ( ) const

Class id of the last classified event.

◆ classLabel() [1/2]

std::string deepstream::AudioFrameMetadata::classLabel ( ) const

Label of the last classified event.

◆ classLabel() [2/2]

std::string deepstream::AudioFrameMetadata::classLabel ( ) const

Label of the last classified event.

◆ confidence() [1/2]

float deepstream::AudioFrameMetadata::confidence ( ) const

Confidence of the last classified event.

◆ confidence() [2/2]

float deepstream::AudioFrameMetadata::confidence ( ) const

Confidence of the last classified event.

◆ format() [1/2]

int deepstream::AudioFrameMetadata::format ( ) const

Audio sample format.

◆ format() [2/2]

int deepstream::AudioFrameMetadata::format ( ) const

Audio sample format.

◆ frameNum() [1/2]

int deepstream::AudioFrameMetadata::frameNum ( ) const

Frame number.

◆ frameNum() [2/2]

int deepstream::AudioFrameMetadata::frameNum ( ) const

Frame number.

◆ inferDone() [1/2]

bool deepstream::AudioFrameMetadata::inferDone ( ) const

Whether inference was performed on the audio frame.

◆ inferDone() [2/2]

bool deepstream::AudioFrameMetadata::inferDone ( ) const

Whether inference was performed on the audio frame.

◆ initiateIterator() [1/4]

void deepstream::AudioFrameMetadata::initiateIterator ( ClassifierMetadata::Iterator ) const

Get the iterator for classifier metadata within it.

◆ initiateIterator() [2/4]

void deepstream::AudioFrameMetadata::initiateIterator ( ClassifierMetadata::Iterator ) const

Get the iterator for classifier metadata within it.

◆ initiateIterator() [3/4]

void deepstream::AudioFrameMetadata::initiateIterator ( UserMetadata::Iterator ,
int  meta_type 
) const

Get the iterator for user metadata within it.

◆ initiateIterator() [4/4]

void deepstream::AudioFrameMetadata::initiateIterator ( UserMetadata::Iterator ,
int  meta_type 
) const

Get the iterator for user metadata within it.

◆ iterate() [1/4]

unsigned int deepstream::AudioFrameMetadata::iterate ( const std::function< void(const ClassifierMetadata &)> &  func) const

Iterate the classifier metadata within it.

◆ iterate() [2/4]

unsigned int deepstream::AudioFrameMetadata::iterate ( const std::function< void(const ClassifierMetadata &)> &  func) const

Iterate the classifier metadata within it.

◆ iterate() [3/4]

unsigned int deepstream::AudioFrameMetadata::iterate ( const std::function< void(const UserMetadata &)> &  func,
int  meta_type 
) const

Iterate the user metadata within it.

◆ iterate() [4/4]

unsigned int deepstream::AudioFrameMetadata::iterate ( const std::function< void(const UserMetadata &)> &  func,
int  meta_type 
) const

Iterate the user metadata within it.

◆ layout() [1/2]

int deepstream::AudioFrameMetadata::layout ( ) const

Audio channel layout.

◆ layout() [2/2]

int deepstream::AudioFrameMetadata::layout ( ) const

Audio channel layout.

◆ ntpTimestamp() [1/2]

uint64_t deepstream::AudioFrameMetadata::ntpTimestamp ( ) const

Holds the ntp timestamp.

◆ ntpTimestamp() [2/2]

uint64_t deepstream::AudioFrameMetadata::ntpTimestamp ( ) const

Holds the ntp timestamp.

◆ numChannels() [1/2]

unsigned int deepstream::AudioFrameMetadata::numChannels ( ) const

Audio channel count.

◆ numChannels() [2/2]

unsigned int deepstream::AudioFrameMetadata::numChannels ( ) const

Audio channel count.

◆ numSamplesPerFrame() [1/2]

int deepstream::AudioFrameMetadata::numSamplesPerFrame ( ) const

Number of samples in the audio frame.

◆ numSamplesPerFrame() [2/2]

int deepstream::AudioFrameMetadata::numSamplesPerFrame ( ) const

Number of samples in the audio frame.

◆ operator bool() [1/2]

virtual deepstream::Metadata::operator bool ( )
inlinevirtualinherited

operator to check if a metadata is void

Reimplemented in deepstream::UserMetadata, and deepstream::UserMetadata.

Definition at line 57 of file 9.1/service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

◆ operator bool() [2/2]

virtual deepstream::Metadata::operator bool ( )
inlinevirtualinherited

operator to check if a metadata is void

Reimplemented in deepstream::UserMetadata, and deepstream::UserMetadata.

Definition at line 57 of file service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

◆ padIndex() [1/2]

unsigned int deepstream::AudioFrameMetadata::padIndex ( ) const

Index of the pad from which the audio frame is generated.

◆ padIndex() [2/2]

unsigned int deepstream::AudioFrameMetadata::padIndex ( ) const

Index of the pad from which the audio frame is generated.

◆ sampleRate() [1/2]

unsigned int deepstream::AudioFrameMetadata::sampleRate ( ) const

Audio sample rate.

◆ sampleRate() [2/2]

unsigned int deepstream::AudioFrameMetadata::sampleRate ( ) const

Audio sample rate.

◆ sourceId() [1/2]

unsigned int deepstream::AudioFrameMetadata::sourceId ( ) const

Identify the source of the frame, e.g.

camera ID

◆ sourceId() [2/2]

unsigned int deepstream::AudioFrameMetadata::sourceId ( ) const

Identify the source of the frame, e.g.

camera ID

Friends And Related Function Documentation

◆ BatchMetadata

BatchMetadata
friend

Definition at line 580 of file service-maker/includes/metadata.hpp.

Field Documentation

◆ data_

void * deepstream::Metadata::data_
protectedinherited

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