ExtendedCamera.enableStream Method

Module: ExtendedCamera

Definition

(C++/dotnet): Toggles the activation state of a specified stream.

C#

public void EnableStream(string streamName, ref bool enabled)

Parameters

streamName string

in Name of the stream to be enabled or disabled.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesExtendedCamera_EnableStream (
    ID3_DEVICES_EXTENDED_CAMERA hExtendedCamera,
    const char * streamName,
    bool * enabled)

Parameters

hExtendedCamera ID3_DEVICES_EXTENDED_CAMERA

in Handle to the ExtendedCamera object.

streamName const char *

in Name of the stream to be enabled or disabled.

enabled bool *

in Specifies the desired state of the stream; on function exit, reflects the actual state considering any constraints (e.g., availability, locks).

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.