Frameset.getFrame Method

Module: Frameset

Definition

Retrieves a specific frame from the frameset, identified by the stream name.

Python

get_frame(self, stream_name: str) -> None

Parameters

stream_name str

in The name of the stream from which to retrieve the frame.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

void getFrame(String? streamName)

Parameters

streamName String

in The name of the stream from which to retrieve the frame.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public void GetFrame(string streamName)

Parameters

streamName string

in The name of the stream from which to retrieve the frame.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public void getFrame(String streamName) throws DevicesException

Parameters

streamName String

in The name of the stream from which to retrieve the frame.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesFrameset_GetFrame (
    ID3_DEVICES_FRAMESET hFrameset,
    const char * streamName)

Parameters

hFrameset ID3_DEVICES_FRAMESET

in Handle to the Frameset object.

streamName const char *

in The name of the stream from which to retrieve the frame.

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.