CPPCli::DataSource Class Reference

The DataSource class represents a data producer in the system hosted by a device. Each DataSource provides a list of DataInterface, each of which provides a particular protocol used to transmit and control the data produced by this DataSource. More...

#include <DataSource.h>

Public Types
enum	Types {   Types::Unknown,   Types::Video,   Types::Audio }
	Values that represent the particular type of a data source. More...
enum	States {   States::Unknown,   States::Offline,   States::Online }
	Values that represent the operational state of a device. More...

Public Member Functions
	DataSource (VxSdk::IVxDataSource *vxDataSource)
	Constructor. More...
virtual	~DataSource ()
	Destructor. More...
	!DataSource ()
	Finaliser. More...
CPPCli::DataSession^	CreateMjpegStream ()
	Create a new MJPEG stream. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
bool	_CanPtz ()
System::Collections::Generic::List< DataStorage^ >^	_GetAllDataStorages ()
System::Collections::Generic::List< ResourceRel^ >^	_GetAudioRelations ()
System::Collections::Generic::List< Clip^ >^	_GetClips ()
System::Collections::Generic::List< DataInterface^ >^	_GetDataInterfaces ()
System::Collections::Generic::List< DataStorage^ >^	_GetDataStorages ()
System::Collections::Generic::List< Clip^ >^	_GetEdgeClips ()
CPPCli::Device^	_GetHostDevice ()
ResourceRel^	_GetLinkedAudioRelation ()
System::Collections::Generic::List< UserInfo^ >^	_GetMultiviewInfo ()
PtzController^	_GetPtzController ()
System::String^	_GetRtspEndpoint ()
System::Collections::Generic::List< ResourceRel^ >^	_GetVideoRelations ()

Package Attributes
VxSdk::IVxDataSource *	_dataSource

Properties
System::Collections::Generic::List< DataStorage^ >^	AllDataStorages [get]
	Gets all data storages associated with this data source; includes edge and failover data storages. More...
System::Collections::Generic::List< ResourceRel^ >^	AudioRelations [get]
	Gets all possible audio resource relations for this data source (both linked and non-linked). Each linked resource shall be considered to be associated to this data source while non-linked resources shall not be (they are available to be associated). More...
System::Collections::Generic::List< Clip^ >^	Clips [get]
	Gets the clips associated with this data source. More...
System::Collections::Generic::List< DataInterface^ >^	DataInterfaces [get]
	Gets all interfaces available for retrieval of data from this data source. More...
System::Collections::Generic::List< DataStorage^ >^	DataStorages [get]
	Gets the data storages that this data source is associated with. More...
System::Collections::Generic::List< Clip^ >^	EdgeClips [get]
	Gets the edge clips associated with this data source; may take a long time (minutes). More...
bool	HasLiveStream [get]
	Gets a value indicating whether the live stream is available. More...
bool	HasRecordedVideo [get]
	Gets a value indicating whether the recorded video is available. More...
CPPCli::Device^	HostDevice [get]
	Gets the device that hosts this data source. More...
System::String^	Id [get]
	Gets the unique identifier for this data source. More...
int	Index [get]
	Gets the zero-based index (per host device) indicating the "position" of the data source (per data source type) within the host device. More...
System::String^	Ip [get]
	Gets the IP. More...
bool	IsCapturing [get]
	Gets a value indicating whether this data source is currently being captured by a recorder. More...
bool	IsPTZ [get]
	Gets a value indicating whether PTZ is enabled. More...
bool	IsRecording [get]
	Gets a value indicating whether the data source is currently recording. More...
ResourceRel^	LinkedAudioRelation [get]
	Gets the currently linked audio resource relation for this data source, if any. More...
System::Collections::Generic::List< UserInfo^ >^	MultiviewInfo [get]
	Gets the multiple viewer information for this data source. This information contains details on the current viewers of this data source. More...
System::String^	Name [get, set]
	Gets or sets the friendly name. More...
int	Number [get, set]
	Gets or sets the number used to designate the data source. More...
PtzController^	PTZController [get]
	Gets the PtzController associated with this data source. More...
System::String^	RtspEndpoint [get]
	Gets the RTSP stream endpoint URI. More...
System::String^	SnapshotUri [get]
	Gets the URI to retrieve the current live frame. More...
States	State [get]
	Gets the current operational state of the associated device. More...
Types	Type [get]
	Gets the type of media this data source contains. More...
System::Collections::Generic::List< ResourceRel^ >^	VideoRelations [get]
	Gets all possible video resource relations for this data source (both linked and non-linked). Each linked resource shall be considered to be associated to this data source while non-linked resources shall not be (they are available to be associated). More...

Detailed Description

The DataSource class represents a data producer in the system hosted by a device. Each DataSource provides a list of DataInterface, each of which provides a particular protocol used to transmit and control the data produced by this DataSource.

Definition at line 20 of file DataSource.h.

Member Enumeration Documentation

enum CPPCli::DataSource::States

strong

Values that represent the operational state of a device.

Enumerator
Unknown	An error or unknown value was returned.
Offline	The device is offline.
Online	The device is online.

Definition at line 40 of file DataSource.h.

                          {
            Unknown,

            Offline,

            Online
        };

enum CPPCli::DataSource::Types

strong

Values that represent the particular type of a data source.

Enumerator
Unknown	An error or unknown value was returned.
Video	A video data source.
Audio	An audio data source.

Definition at line 26 of file DataSource.h.

                         {
            Unknown,

            Video,

            Audio
        };

Constructor & Destructor Documentation

CPPCli::DataSource::DataSource

(

VxSdk::IVxDataSource *

vxDataSource

)

Constructor.

Parameters

vxDataSource

The vx data source.

Definition at line 10 of file DataSource.cpp.

                                                             {
    _dataSource = vxDataSource;
}

virtual CPPCli::DataSource::~DataSource ( )

inlinevirtual

Destructor.

Definition at line 60 of file DataSource.h.

                              {
            this->!DataSource();
        }

CPPCli::DataSource::!DataSource

(

)

Finaliser.

Definition at line 14 of file DataSource.cpp.

                              {
    _dataSource->Delete();
    _dataSource = nullptr;
}

Member Function Documentation

bool CPPCli::DataSource::_CanPtz ( )

package

Definition at line 36 of file DataSource.cpp.

                               {
    bool result;
    _dataSource->CanPtz(result);
    return result;
}

List< CPPCli::DataStorage^ > CPPCli::DataSource::_GetAllDataStorages ( )

package

Definition at line 42 of file DataSource.cpp.

                                                                {
    // Create a list of managed data storages
    List<DataStorage^>^ mlist = gcnew List<DataStorage^>();
    // Create a collection of unmanaged data storages
    VxSdk::VxCollection<VxSdk::IVxDataStorage**> dataStorages;

    // Make the GetAllDataStorages call, which will return with the total data storage count, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataSource->GetAllDataStorages(dataStorages);
    // As long as there are data storages from this datasource the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxDataStorage collection
        dataStorages.collection = new VxSdk::IVxDataStorage*[dataStorages.collectionSize];
        result = _dataSource->GetAllDataStorages(dataStorages);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < dataStorages.collectionSize; i++)
                mlist->Add(gcnew CPPCli::DataStorage(dataStorages.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] dataStorages.collection;
    }
    return mlist;
}

List< CPPCli::ResourceRel^ > CPPCli::DataSource::_GetAudioRelations ( )

package

Definition at line 66 of file DataSource.cpp.

                                                               {
    // Create a list of managed related resources
    List<ResourceRel^>^ mlist = gcnew List<ResourceRel^>();
    // Create a collection of unmanaged related resources
    VxSdk::VxCollection<VxSdk::IVxResourceRel**> resourceRels;

    // Make the GetAudioRelations call, which will return with the total resource count, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataSource->GetAudioRelations(resourceRels);
    // As long as there are related resources for this datasource the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxResourceRel collection
        resourceRels.collection = new VxSdk::IVxResourceRel*[resourceRels.collectionSize];
        result = _dataSource->GetAudioRelations(resourceRels);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < resourceRels.collectionSize; i++)
                mlist->Add(gcnew CPPCli::ResourceRel(resourceRels.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] resourceRels.collection;
    }
    return mlist;
}

List< CPPCli::Clip^ > CPPCli::DataSource::_GetClips ( )

package

Definition at line 90 of file DataSource.cpp.

                                               {
    // Create a list of managed clips
    List<Clip^>^ mlist = gcnew List<Clip^>();
    // Create a collection of unmanaged clips
    VxSdk::VxCollection<VxSdk::IVxClip**> clips;

    // Make the GetClips call, which will return with the total clip count, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataSource->GetClips(clips);
    // As long as there are clips from this datasource the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxClip collection
        clips.collection = new VxSdk::IVxClip*[clips.collectionSize];
        result = _dataSource->GetClips(clips);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < clips.collectionSize; i++)
                mlist->Add(gcnew CPPCli::Clip(clips.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] clips.collection;
    }
    return mlist;
}

List< CPPCli::DataInterface^ > CPPCli::DataSource::_GetDataInterfaces ( )

package

Definition at line 114 of file DataSource.cpp.

                                                                 {
    // Create a list of managed export objects
    List<DataInterface^>^ mlist = gcnew List<DataInterface^>();
    for (int i = 0; i < _dataSource->dataInterfaceSize; i++)
        mlist->Add(gcnew DataInterface(_dataSource->dataInterfaces[i]));

    return mlist;
}

List< CPPCli::DataStorage^ > CPPCli::DataSource::_GetDataStorages ( )

package

Definition at line 123 of file DataSource.cpp.

                                                             {
    // Create a list of managed data storages
    List<DataStorage^>^ mlist = gcnew List<DataStorage^>();
    // Create a collection of unmanaged data storages
    VxSdk::VxCollection<VxSdk::IVxDataStorage**> dataStorages;

    // Make the GetDataStorages call, which will return with the total data storage count, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataSource->GetDataStorages(dataStorages);
    // As long as there are data storages from this datasource the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxDataStorage collection
        dataStorages.collection = new VxSdk::IVxDataStorage*[dataStorages.collectionSize];
        result = _dataSource->GetDataStorages(dataStorages);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < dataStorages.collectionSize; i++)
                mlist->Add(gcnew CPPCli::DataStorage(dataStorages.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] dataStorages.collection;
    }
    return mlist;
}

List< CPPCli::Clip^ > CPPCli::DataSource::_GetEdgeClips ( )

package

Definition at line 147 of file DataSource.cpp.

                                                   {
    // Create a list of managed clips
    List<Clip^>^ mlist = gcnew List<Clip^>();
    // Create a collection of unmanaged clips
    VxSdk::VxCollection<VxSdk::IVxClip**> clips;

    // Make the GetEdgeClips call, which will return with the total clip count, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataSource->GetEdgeClips(clips);
    // As long as there are clips from this datasource the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxClip collection
        clips.collection = new VxSdk::IVxClip*[clips.collectionSize];
        result = _dataSource->GetEdgeClips(clips);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < clips.collectionSize; i++)
                mlist->Add(gcnew CPPCli::Clip(clips.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] clips.collection;
    }
    return mlist;
}

CPPCli::Device CPPCli::DataSource::_GetHostDevice ( )

package

Definition at line 171 of file DataSource.cpp.

                                               {
    // Get the device which hosts this data source
    VxSdk::IVxDevice* device = nullptr;
    VxSdk::VxResult::Value result = _dataSource->GetHostDevice(device);

    // Return the device if GetHostDevice was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew Device(device);

    return nullptr;
}

CPPCli::ResourceRel CPPCli::DataSource::_GetLinkedAudioRelation ( )

package

Definition at line 183 of file DataSource.cpp.

                                                             {
    // Create a managed ResourceRel object
    CPPCli::ResourceRel^ resourceRel = nullptr;
    // Create a collection of unmanaged related resources
    VxSdk::VxCollection<VxSdk::IVxResourceRel**> resourceRels;
    resourceRels.filterSize = 1;
    VxSdk::VxCollectionFilter filters[1];
    resourceRels.filters = filters;
    resourceRels.filters[0].key = VxSdk::VxCollectionFilterItem::kLinked;
    VxSdk::Utilities::StrCopySafe(resourceRels.filters[0].value, Utils::ConvertSysString("true"));

    // Make the GetAudioRelations call, which will return with the total resource count, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataSource->GetAudioRelations(resourceRels);
    // As long as there are related resources for this datasource the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxResourceRel collection
        resourceRels.collection = new VxSdk::IVxResourceRel*[resourceRels.collectionSize];
        result = _dataSource->GetAudioRelations(resourceRels);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            if (resourceRels.collectionSize > 0)
                resourceRel = gcnew CPPCli::ResourceRel(resourceRels.collection[0]);
        }

        // Remove the memory we previously allocated to the collection
        delete[] resourceRels.collection;
    }
    return resourceRel;
}

System::Collections::Generic::List< CPPCli::UserInfo^ > CPPCli::DataSource::_GetMultiviewInfo ( )

package

Definition at line 213 of file DataSource.cpp.

                                                                                   {
    // Create a list of managed user info objects
    List<UserInfo^>^ mlist = gcnew List<UserInfo^>();
    // Create a collection of unmanaged user info objects
    VxSdk::VxCollection<VxSdk::IVxUserInfo**> userInfos;

    // Make the GetMultiviewInfo call, which will return with the total user info object count, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataSource->GetMultiviewInfo(userInfos);
    // As long as there are user info objects for this datasource the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxUserInfo collection
        userInfos.collection = new VxSdk::IVxUserInfo*[userInfos.collectionSize];
        result = _dataSource->GetMultiviewInfo(userInfos);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < userInfos.collectionSize; i++)
                mlist->Add(gcnew CPPCli::UserInfo(userInfos.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] userInfos.collection;
    }
    return mlist;
}

CPPCli::PtzController CPPCli::DataSource::_GetPtzController ( )

package

Definition at line 237 of file DataSource.cpp.

                                                         {
    // Check to ensure this datasource is a ptz camera
    bool isPtz;
    VxSdk::VxResult::Value result = _dataSource->CanPtz(isPtz);

    if (isPtz) {
        // Get the ptz controller which allows the client to make ptz calls
        VxSdk::IVxPtzController* ptzController = nullptr;
        result = _dataSource->GetPtzController(ptzController);

        // Return the ptz controller if GetPtzController was successful
        if (result == VxSdk::VxResult::kOK)
            return gcnew PtzController(ptzController);
    }
    return nullptr;
}

System::String CPPCli::DataSource::_GetRtspEndpoint ( )

package

Definition at line 254 of file DataSource.cpp.

                                                 {
    char* rtspEndpoint = nullptr;
    int size = 0;

    // If the rtsp uri is not available on the datasource the result will return VxSdk::VxResult::kActionUnavailable,
    // otherwise VxSdk::VxResult::kInsufficientSize
    VxSdk::VxResult::Value result = _dataSource->GetRtspEndpoint(rtspEndpoint, size);
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for rtspEndpoint
        rtspEndpoint = new char[size];
        // The result should now be kOK since we have allocated enough space
        _dataSource->GetRtspEndpoint(rtspEndpoint, size);
    }
    return gcnew System::String(rtspEndpoint);
}

List< CPPCli::ResourceRel^ > CPPCli::DataSource::_GetVideoRelations ( )

package

Definition at line 270 of file DataSource.cpp.

                                                               {
    // Create a list of managed related resources
    List<ResourceRel^>^ mlist = gcnew List<ResourceRel^>();
    // Create a collection of unmanaged related resources
    VxSdk::VxCollection<VxSdk::IVxResourceRel**> resourceRels;

    // Make the GetVideoRelations call, which will return with the total resource count, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataSource->GetVideoRelations(resourceRels);
    // As long as there are related resources for this datasource the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxResourceRel collection
        resourceRels.collection = new VxSdk::IVxResourceRel*[resourceRels.collectionSize];
        result = _dataSource->GetVideoRelations(resourceRels);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < resourceRels.collectionSize; i++)
                mlist->Add(gcnew CPPCli::ResourceRel(resourceRels.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] resourceRels.collection;
    }
    return mlist;
}

CPPCli::DataSession CPPCli::DataSource::CreateMjpegStream

(

)

Create a new MJPEG stream.

Returns

nullptr if it fails, else the new MJPEG streams DataSession.

Definition at line 19 of file DataSource.cpp.

                                                       {
    // Create a data session object
    VxSdk::IVxDataSession* dataSession;

    // If the mjpeg protocol is not available on the datasource the result will return VxSdk::VxResult::kActionUnavailable,
    // otherwise VxSdk::VxResult::kOK
    VxSdk::VxResult::Value result = _dataSource->CreateMjpegDataSession(dataSession);
    if (result == VxSdk::VxResult::kOK)
        return gcnew DataSession(dataSession);

    return nullptr;
}

CPPCli::Results::Value CPPCli::DataSource::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 32 of file DataSource.cpp.

                                             {
    return (CPPCli::Results::Value)_dataSource->Refresh();
}

Member Data Documentation

VxSdk::IVxDataSource* CPPCli::DataSource::_dataSource

package

Definition at line 319 of file DataSource.h.

Property Documentation

System:: Collections:: Generic:: List< DataStorage^>^ CPPCli::DataSource::AllDataStorages

get

Gets all data storages associated with this data source; includes edge and failover data storages.

A List of all associated data storages.

Definition at line 85 of file DataSource.h.

System:: Collections:: Generic:: List< ResourceRel^>^ CPPCli::DataSource::AudioRelations

get

Gets all possible audio resource relations for this data source (both linked and non-linked). Each linked resource shall be considered to be associated to this data source while non-linked resources shall not be (they are available to be associated).

A List of related audio resources.

Definition at line 96 of file DataSource.h.

System:: Collections:: Generic:: List< Clip^>^ CPPCli::DataSource::Clips

get

Gets the clips associated with this data source.

A List of the associated clips.

Definition at line 105 of file DataSource.h.

System:: Collections:: Generic:: List< DataInterface^>^ CPPCli::DataSource::DataInterfaces

get

Gets all interfaces available for retrieval of data from this data source.

A List of the data interfaces.

Definition at line 114 of file DataSource.h.

System:: Collections:: Generic:: List< DataStorage^>^ CPPCli::DataSource::DataStorages

get

Gets the data storages that this data source is associated with.

A List of the associated data storages.

Definition at line 123 of file DataSource.h.

System:: Collections:: Generic:: List< Clip^>^ CPPCli::DataSource::EdgeClips

get

Gets the edge clips associated with this data source; may take a long time (minutes).

A List of the associated edge clips.

Definition at line 132 of file DataSource.h.

bool CPPCli::DataSource::HasLiveStream

get

Gets a value indicating whether the live stream is available.

true if live is available, false if not.

Definition at line 141 of file DataSource.h.

bool CPPCli::DataSource::HasRecordedVideo

get

Gets a value indicating whether the recorded video is available.

true if recorded video is available, false if not.

Definition at line 150 of file DataSource.h.

CPPCli:: Device^ CPPCli::DataSource::HostDevice

get

Gets the device that hosts this data source.

The host device.

Definition at line 159 of file DataSource.h.

System:: String^ CPPCli::DataSource::Id

get

Gets the unique identifier for this data source.

The unique identifier.

Definition at line 168 of file DataSource.h.

int CPPCli::DataSource::Index

get

Gets the zero-based index (per host device) indicating the "position" of the data source (per data source type) within the host device.

The data source index.

Definition at line 178 of file DataSource.h.

System:: String^ CPPCli::DataSource::Ip

get

Gets the IP.

The IP.

Definition at line 187 of file DataSource.h.

bool CPPCli::DataSource::IsCapturing

get

Gets a value indicating whether this data source is currently being captured by a recorder.

true if capturing, false if not.

Definition at line 196 of file DataSource.h.

bool CPPCli::DataSource::IsPTZ

get

Gets a value indicating whether PTZ is enabled.

true if PTZ is enabled, false if not.

Definition at line 205 of file DataSource.h.

bool CPPCli::DataSource::IsRecording

get

Gets a value indicating whether the data source is currently recording.

true if recording, false if not.

Definition at line 214 of file DataSource.h.

ResourceRel^ CPPCli::DataSource::LinkedAudioRelation

get

Gets the currently linked audio resource relation for this data source, if any.

The linked audio resource if available, otherwise nullptr.

Definition at line 223 of file DataSource.h.

System:: Collections:: Generic:: List< UserInfo^>^ CPPCli::DataSource::MultiviewInfo

get

Gets the multiple viewer information for this data source. This information contains details on the current viewers of this data source.

A List of user information for all viewers of this data source.

Definition at line 233 of file DataSource.h.

System:: String^ CPPCli::DataSource::Name

getset

Gets or sets the friendly name.

The friendly name.

Definition at line 242 of file DataSource.h.

int CPPCli::DataSource::Number

getset

Gets or sets the number used to designate the data source.

The data source number.

Definition at line 256 of file DataSource.h.

PtzController^ CPPCli::DataSource::PTZController

get

Gets the PtzController associated with this data source.

nullptr if PTZ is not supported on the device, else the PtzController.

Definition at line 266 of file DataSource.h.

System:: String^ CPPCli::DataSource::RtspEndpoint

get

Gets the RTSP stream endpoint URI.

The RTSP endpoint.

Definition at line 275 of file DataSource.h.

System:: String^ CPPCli::DataSource::SnapshotUri

get

Gets the URI to retrieve the current live frame.

The JPEG URI.

Definition at line 284 of file DataSource.h.

States CPPCli::DataSource::State

get

Gets the current operational state of the associated device.

The current device state.

Definition at line 293 of file DataSource.h.

Types CPPCli::DataSource::Type

get

Gets the type of media this data source contains.

The media type.

Definition at line 302 of file DataSource.h.

System:: Collections:: Generic:: List< ResourceRel^>^ CPPCli::DataSource::VideoRelations

get

Gets all possible video resource relations for this data source (both linked and non-linked). Each linked resource shall be considered to be associated to this data source while non-linked resources shall not be (they are available to be associated).

A List of related video resources.

Definition at line 313 of file DataSource.h.

---

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

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/DataSource.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/DataSource.cpp