ExtendedCamera.getStreamStatus Method

Module: ExtendedCamera

Definition

Queries the current status (enabled/disabled) of a specific stream.

Python

get_stream_status(self, stream_name: str) -> bool

Parameters

stream_name str

in The stream whose status is being checked.

Returns

bool

Outputs the stream’s current state, indicating whether it is active.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

bool getStreamStatus(String? streamName)

Parameters

streamName String

in The stream whose status is being checked.

Returns

bool

Outputs the stream’s current state, indicating whether it is active.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public bool GetStreamStatus(string streamName)

Parameters

streamName string

in The stream whose status is being checked.

Returns

bool

Outputs the stream’s current state, indicating whether it is active.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public boolean getStreamStatus(String streamName) throws DevicesException

Parameters

streamName String

in The stream whose status is being checked.

Returns

boolean

Outputs the stream’s current state, indicating whether it is active.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesExtendedCamera_GetStreamStatus (
    ID3_DEVICES_EXTENDED_CAMERA hExtendedCamera,
    const char * streamName,
    bool * status)

Parameters

hExtendedCamera ID3_DEVICES_EXTENDED_CAMERA

in Handle to the ExtendedCamera object.

streamName const char *

in The stream whose status is being checked.

status bool *

out Outputs the stream’s current state, indicating whether it is active.

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.