VideoOS.Platform.Metadata.MetadataStream Class Reference

This class is responsible for representing a Frame in ONVIF XML. More...

Inheritance diagram for VideoOS.Platform.Metadata.MetadataStream:

Public Member Functions

bool Equals (MetadataStream other)
 Provides value type equality semantics.
 
override bool Equals (object obj)
 Provides value type equality semantics.
 
IEnumerable< FrameGetAllFrames ()
 Gets all frames included in all video analytics elements. In other words, this method returns all frames in this metadata stream instance.
 
Frame GetFrame ()
 Gets the first frame or null if there are no frames. This is useful if the client of this class can only handle a single frame per metadata stream anyway.
 
override int GetHashCode ()
 object.GetHashCode
 
System.Xml.Schema.XmlSchema GetSchema ()
 IXmlSerializable.GetSchema
 
void ReadXml (XmlReader reader)
 IXmlSerializable.ReadXml
 
void WriteXml (XmlWriter writer)
 IXmlSerializable.WriteXml
 

Properties

NavigationalData NavigationalData [get, set]
 Gets or sets the navigational data.
 
List< byte > OriginalData [get]
 Gets the list of original data bytes.
 
List< VideoAnalyticsVideoAnalyticsItems [get]
 Gets the list of video analytics elements contained in this instance.
 

Detailed Description

This class is responsible for representing a Frame in ONVIF XML.

Member Function Documentation

◆ Equals() [1/2]

bool VideoOS.Platform.Metadata.MetadataStream.Equals ( MetadataStream other)
inline

Provides value type equality semantics.

◆ Equals() [2/2]

override bool VideoOS.Platform.Metadata.MetadataStream.Equals ( object obj)
inline

Provides value type equality semantics.

◆ GetAllFrames()

IEnumerable< Frame > VideoOS.Platform.Metadata.MetadataStream.GetAllFrames ( )
inline

Gets all frames included in all video analytics elements. In other words, this method returns all frames in this metadata stream instance.

Returns
An IEnumerable<T> of all frames in the metadata

◆ GetFrame()

Frame VideoOS.Platform.Metadata.MetadataStream.GetFrame ( )
inline

Gets the first frame or null if there are no frames. This is useful if the client of this class can only handle a single frame per metadata stream anyway.

Returns
The first frame or null

◆ GetHashCode()

override int VideoOS.Platform.Metadata.MetadataStream.GetHashCode ( )
inline

object.GetHashCode

◆ GetSchema()

System.Xml.Schema.XmlSchema VideoOS.Platform.Metadata.MetadataStream.GetSchema ( )
inline

IXmlSerializable.GetSchema

◆ ReadXml()

void VideoOS.Platform.Metadata.MetadataStream.ReadXml ( XmlReader reader)
inline

IXmlSerializable.ReadXml

◆ WriteXml()

void VideoOS.Platform.Metadata.MetadataStream.WriteXml ( XmlWriter writer)
inline

IXmlSerializable.WriteXml

Property Documentation

◆ NavigationalData

NavigationalData VideoOS.Platform.Metadata.MetadataStream.NavigationalData
getset

Gets or sets the navigational data.

◆ OriginalData

List<byte> VideoOS.Platform.Metadata.MetadataStream.OriginalData
get

Gets the list of original data bytes.

◆ VideoAnalyticsItems

List<VideoAnalytics> VideoOS.Platform.Metadata.MetadataStream.VideoAnalyticsItems
get

Gets the list of video analytics elements contained in this instance.