Skip to content

connect_image_sourceConnectImageSourceConnectImageSourceconnect_image_sourceT_connect_image_source🔗

Short description🔗

connect_image_sourceConnectImageSourceConnectImageSourceconnect_image_sourceT_connect_image_source — Connect to an image source.

Signature🔗

connect_image_source( image_source ImageSourceHandle, attribute.name GenParamName, attribute.value GenParamValue )void ConnectImageSource( const HTuple& ImageSourceHandle, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.ConnectImageSource( HTuple imageSourceHandle, HTuple genParamName, HTuple genParamValue )def connect_image_source( image_source_handle: HHandle, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[int, float, str]] ) -> None

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

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

void HImageSource.ConnectImageSource( HTuple genParamName, HTuple genParamValue )

Description🔗

connect_image_sourceConnectImageSource connects to the image source modules (device, plugin, etc.) specified in ImageSourceHandleimageSourceHandleimage_source_handle.

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

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

Currently, no generic parameters GenParamNamegenParamNamegen_param_name and GenParamValuegenParamValuegen_param_value are supported.

Execution information🔗

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🔗

ImageSourceHandleimageSourceHandleimage_source_handle (input_control) image_source → (handle)HTuple (HHandle)HImageSource, HTuple (IntPtr)HHandleHtuple (handle)

Image source handle to be connected.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Generic parameter name.

Default: [][]

GenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → (integer / real / string)HTuple (Hlong / double / HString)HTuple (int / long / double / string)Sequence[Union[int, float, str]]Htuple (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_sourceConnectImageSource returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

query_image_sourcesQueryImageSources, create_image_sourceCreateImageSource

Possible successors

get_image_source_paramGetImageSourceParam, set_image_source_paramSetImageSourceParam, start_image_sourceStartImageSource

See also

disconnect_image_sourceDisconnectImageSource

Module🔗

Foundation