streaming

Provides a module for streaming services.

Classes:

StreamingService(stream_begin_method, ...)

Encapsulates a CFX streaming service.

class ansys.cfx.core.streaming_services.streaming.StreamingService(stream_begin_method, target, streaming_service)

Bases: object

Encapsulates a CFX streaming service.

Methods:

__init__(stream_begin_method, target, ...)	Initialize an instance of the StreamingService class.
register_callback(callback, *args, **kwargs)	Register the callback.
start(*args, **kwargs)	Start streaming.
stop()	Stop streaming.
unregister_callback(callback_id)	Unregister the callback.

Attributes:

is_streaming

Flag indicating if streaming.

__init__(stream_begin_method, target, streaming_service)

Initialize an instance of the StreamingService class.

property is_streaming

Flag indicating if streaming.

register_callback(callback: Callable, *args, **kwargs) → str

Register the callback.

Parameters:

callbackCallable

Callback to register.

argsAny

Arguments.

kwargsAny

Keyword arguments.

Returns:

str

Registered callback ID.

start(*args, **kwargs) → None

Start streaming.

stop() → None

Stop streaming.

unregister_callback(callback_id: str)

Unregister the callback.

Parameters:

callback_idstr

ID of the registered callback.