stream_to_file

Save the streaming session to a file

Parameters

name string

The name of the file to save the stream to. The file's extension controls the type of file that is written and must be one of csv, mat or npy. If this parameter is not given then a CSV file is written, where the name of the file includes the current timestamp.

default: STREAM_<YYYYMMDDHHMMSS>.csv

This function returns as soon as the streaming starts. The progress of the streaming can be monitored using get_stream_status(). Alternatively call wait_for_stream_to_file() to block until the streaming is finished and the file is fully written.

Note

Data streaming requires mokucli (opens new window).

This method cannot be called directly as a REST endpoint.

Examples