Python binding for Rust Media Cloud AI Worker SDK

Build

To build the rust application

cargo build

Test

To run the unit tests, you must build the provided worker example (see the Build section above).

cargo test

Usage

This worker uses the PyO3 crate to load a Python file, and to execute it. The Python worker must implement some functions to be correctly bound:

get_name() -> str: to retrieve the worker name
get_short_description() -> str: to retrieve a short description of the worker
get_description() -> str: to describe the worker purpose
get_version() -> str: to retrieve the worker version
init(): to initialize the worker process (optional)
process(handle_callback, parameters) -> dict: to execute the worker process and return the job result

If the media feature is enabled, the following function must be implemented:

init_process(stream_handler, format_context, parameters): to initialize the media worker process
process_frame(job_id, stream_index, frame): to process an input audio/video frame
ending_process(parameters): to end the media worker process

NB: the process(handle_callback, parameters) function is not called when the media feature is enabled.

For more details, see the provided worker.py and media_worker.py examples.

Set the PYTHON_WORKER_FILENAME environment variable to specify the path of your Python worker. Otherwise, the worker.py file will be loaded by default.

Running examples

Simple worker

RUST_LOG=debug \
SOURCE_ORDERS="examples/message.json" \
PYTHON_WORKER_FILENAME="worker.py" \
SOURCE_PATH="README.md" \
DESTINATION_PATH="README.md.out" \
cargo run

Media worker

First set the media filename:

export SOURCE_PATH="/folder/filename.ext"

Then run the SDK with these parameters:

RUST_LOG=debug \
SOURCE_ORDERS="examples/message.json" \
PYTHON_WORKER_FILENAME="media_worker.py" \
DESTINATION_PATH="results.json" \
cargo run --features media