Operator Reference

connect_image_sourceT_connect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source (Operator)

connect_image_sourceT_connect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source — Connect to an image source.

Signature

connect_image_source( : : ImageSourceHandle, GenParamName, GenParamValue : )

Herror T_connect_image_source(const Htuple ImageSourceHandle, const Htuple GenParamName, const Htuple GenParamValue)

void ConnectImageSource(const HTuple& ImageSourceHandle, const HTuple& GenParamName, const HTuple& GenParamValue)

void HImageSource::ConnectImageSource(const HTuple& GenParamName, const HTuple& GenParamValue) const

def connect_image_source(image_source_handle: HHandle, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[int, float, str]]) -> None

Description

connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source connects to the image source modules (device, plugin, etc.) specified in ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle.

For further information about the states of an image source see Image Source.

When calling connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source with an image source handle containing invalid identifiers, an error is thrown.

Currently, no generic parameters GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value are supported.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle (input_control)  image_source HImageSource, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Image source handle to be connected.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name-array HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Generic parameter name.

Default: []

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value-array HTupleSequence[Union[int, float, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Generic parameter value.

Default: []

Result

If the parameter values are correct and the desired image source modules could be connected, connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

query_image_sourcesquery_image_sourcesQueryImageSourcesQueryImageSourcesquery_image_sources, create_image_sourcecreate_image_sourceCreateImageSourceCreateImageSourcecreate_image_source

Possible Successors

get_image_source_paramget_image_source_paramGetImageSourceParamGetImageSourceParamget_image_source_param, set_image_source_paramset_image_source_paramSetImageSourceParamSetImageSourceParamset_image_source_param, start_image_sourcestart_image_sourceStartImageSourceStartImageSourcestart_image_source

See also

disconnect_image_sourcedisconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source

Module

Foundation