Skip to content

stop_image_sourceStopImageSourceStopImageSourcestop_image_sourceT_stop_image_source🔗

Short description🔗

stop_image_sourceStopImageSourceStopImageSourcestop_image_sourceT_stop_image_source — Stop the continuous acquisition, transmission and reception of images of the image source.

Signature🔗

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

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

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

void HImageSource.StopImageSource( HTuple genParamName, HTuple genParamValue )

Description🔗

stop_image_sourceStopImageSource stops the continuous acquisition, transmission and reception of images of the image source device defined in the handle ImageSourceHandleimageSourceHandleimage_source_handle. It withdraws the preparations performed by start_image_sourceStartImageSource. The status parameter 'stream_state'"stream_state" changes from 'running'"running" to 'initialized'"initialized".

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

stop_image_sourceStopImageSource can be used from another thread to abort a blocking call of fetch_from_image_sourceFetchFromImageSource.

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)

Handle of the image source to stop the stream.

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, stop_image_sourceStopImageSource returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

start_image_sourceStartImageSource, fetch_from_image_sourceFetchFromImageSource

Possible successors

disconnect_image_sourceDisconnectImageSource

See also

start_image_sourceStartImageSource

Module🔗

Foundation