PipelineSystemControllerInterfaceFactory

PipelineSystemControllerInterfaceFactory

Public Functions

Public Functions Documentation

function PipelineSystemControllerInterfaceFactory

PipelineSystemControllerInterfaceFactory(
    const std::string & systemControllerIP,
    uint16_t systemControllerPort,
    const std::string & systemControllerPostfix,
    const std::string & psk,
    const std::string & myIP,
    bool useHTTPS,
    bool allowInsecureHTTPS
)

Constructor.

Parameters:

• systemControllerIP The IP address of the System controller to connect to.
• systemControllerPort The network port of the System controller to connect to.
• systemControllerPostfix The postfix of the System controller’s address, to chose which API endpoints to use.
• psk The Pre-shared key used for authorization at the System controller.
• myIP The public IP address of the pipeline, i.e. the external IP used to connect to the pipeline.
• useHTTPS If HTTPS should be used instead of HTTP
• allowInsecureHTTPS Set to true to allow self-signed HTTPS certificates. Should normally be false.

function PipelineSystemControllerInterfaceFactory

PipelineSystemControllerInterfaceFactory(
    PipelineSystemControllerInterfaceFactory const & 
) =delete

function PipelineSystemControllerInterfaceFactory

PipelineSystemControllerInterfaceFactory(
    PipelineSystemControllerInterfaceFactory const && 
) =delete

function operator=

PipelineSystemControllerInterfaceFactory & operator=(
    PipelineSystemControllerInterfaceFactory const & 
) =delete

function operator=

PipelineSystemControllerInterfaceFactory & operator=(
    PipelineSystemControllerInterfaceFactory const && 
) =delete

function getMediaReceiverInterface

std::shared_ptr< SystemControllerConnection > getMediaReceiverInterface(
    const std::string & name
)

Get the interface to the MediaReceiver. Multiple calls to this method will return the same interface. Internally the UUID is randomly generated and the correct type is set.

Parameters:

• name The human readable name of the MediaReceiver to provide to the System controller

Return: A configured connection on success, otherwise nullptr

function createMediaStreamerInterface

std::shared_ptr< SystemControllerConnection > createMediaStreamerInterface(
    const std::string & name
)

Create a new SystemControllerInterface to a MediaStreamer. Multiple calls to this method will return new interfaces each time. Internally the UUID is randomly generated, the correct type is set and the MediaReceiver is set as parent. The.

Parameters:

• name The human readable name of the MediaStreamer to provide to the System controller

See: getMediaReceiverInterface must be called before this method is called

Return: A configured connection on success, otherwise nullptr

function createControlReceiverInterface

std::shared_ptr< SystemControllerConnection > createControlReceiverInterface(
    const std::string & name
)

Create a new SystemControllerInterface to a ControlReceiver. Multiple calls to this method will return new interfaces each time. Internally the UUID is randomly generated, the correct type is set and the MediaReceiver is set as parent. The.

Parameters:

• name The human readable name of the ControlReceiver to provide to the System controller

See: getMediaReceiverInterface must be called before this method is called to generate the parent interface.

Return: A configured connection on success, otherwise nullptr

Updated on 2023-01-23 at 12:02:53 +0100