StreamServiceClient

class kanzi::connect::StreamServiceClient : public AbstractServiceClient

Public Types

typedef std::function<void(const kanzi::string &streamId, const kanzi::string &blob, const int &flags)> NewBlobCallbackFunction
typedef kanzi::vector<kanzi::shared_ptr<NewBlobSubscription>> NewBlobSubscriptionContainer
typedef std::function<void(const kanzi::string &streamId, const kanzi::string &parameterName, const kanzi::string &parameterValue)> ReceiveEncoderParameterCallbackFunction
typedef kanzi::vector<kanzi::shared_ptr<ReceiveEncoderParameterSubscription>> ReceiveEncoderParameterSubscriptionContainer
typedef std::function<void(const StreamInfo &streamInfo)> ReceiveStreamInfoCallbackFunction
typedef kanzi::vector<kanzi::shared_ptr<ReceiveStreamInfoSubscription>> ReceiveStreamInfoSubscriptionContainer
typedef kanzi::shared_ptr<void> StreamSubscriptionToken
typedef std::function<void(bool, int32_t)> SubscribeBlobsCompleteFunction
typedef std::function<void(const kanzi::string &streamId, const bool &subscribed)> SubscriptionResultCallbackFunction
typedef kanzi::vector<kanzi::shared_ptr<SubscriptionResultSubscription>> SubscriptionResultSubscriptionContainer

Public Functions

StreamServiceClient(ClientSharedPtr client, const kanzi::string &type = StreamServiceClient::Type())
virtual  ~StreamServiceClient () KZ_OVERRIDE
StreamSubscriptionToken addNewBlobSubscription(NewBlobCallbackFunction function)
StreamSubscriptionToken addNewBlobSubscriptionEx(NewBlobCallbackObserver *observer)
StreamSubscriptionToken addReceiveEncoderParameterSubscription(ReceiveEncoderParameterCallbackFunction function)
StreamSubscriptionToken addReceiveEncoderParameterSubscriptionEx(ReceiveEncoderParameterCallbackObserver *observer)
StreamSubscriptionToken addReceiveStreamInfoSubscription(ReceiveStreamInfoCallbackFunction function)
StreamSubscriptionToken addReceiveStreamInfoSubscriptionEx(ReceiveStreamInfoCallbackObserver *observer)
StreamSubscriptionToken addSubscribeBlobsCompleteSubscription(SubscribeBlobsCompleteFunction function)
StreamSubscriptionToken addSubscriptionResultSubscription(SubscriptionResultCallbackFunction function)
StreamSubscriptionToken addSubscriptionResultSubscriptionEx(SubscriptionResultCallbackObserver *observer)
virtual kanzi::string getIdentifier () const KZ_OVERRIDE

Returns the type of the service.

Return

Identifier of the service, as a string.

void notifyNewBlob(const kanzi::string &streamId, const kanzi::string &blob, const int &flags)
void notifyReceiveEncoderParameter(const kanzi::string &streamId, const kanzi::string &parameterName, const kanzi::string &parameterValue)
void notifyReceiveStreamInfo(const StreamInfo &streamInfo)
void notifySubscribeBlobsComplete(kanzi::connect::RPCResult<bool> &result)
void notifySubscribeBlobsCompleteNotExecuted()
void notifySubscriptionResult(const kanzi::string &streamId, const bool &subscribed)
void onNewBlob(const kanzi::string &streamId, const kanzi::string &blob, const int &flags)
void onReceiveEncoderParameter(const kanzi::string &streamId, const kanzi::string &parameterName, const kanzi::string &parameterValue)
void onReceiveStreamInfo(const StreamInfo &streamInfo)
void onSubscriptionResult(const kanzi::string &streamId, const bool &subscribed)
void removeNewBlobSubscription(StreamSubscriptionToken token)
void removeReceiveEncoderParameterSubscription(StreamSubscriptionToken token)
void removeReceiveStreamInfoSubscription(StreamSubscriptionToken token)
void removeSubscribeBlobsCompleteSubscription(StreamSubscriptionToken token)
void removeSubscription(const kanzi::string &streamId)
void removeSubscriptionResultSubscription(StreamSubscriptionToken token)
void requestEncoderParameter(const kanzi::string &streamId, const kanzi::string &parameterName)
void requestStreamInfo(const kanzi::string &streamId)
void restartEncoder(const kanzi::string &streamId)
void setEncoderParameter(const kanzi::string &streamId, const kanzi::string &parameterName, const kanzi::string &parameterValue)
void setStreamContent(const kanzi::string &streamId, const kanzi::string &contentDescription)
kanzi::connect::RPCResult<bool> subscribeBlobs(const kanzi::string &streamId)

Public Members

NewBlobSubscriptionContainer m_newBlobSubscriptions
ReceiveEncoderParameterSubscriptionContainer m_receiveEncoderParameterSubscriptions
ReceiveStreamInfoSubscriptionContainer m_receiveStreamInfoSubscriptions
kanzi::vector<kanzi::shared_ptr<SubscribeBlobsCompleteSubscription>> m_subscribeBlobsCompletionCallbacks
SubscriptionResultSubscriptionContainer m_subscriptionResultSubscriptions

Public Static Functions

static inline StreamServiceClientSharedPtr create(ClientSharedPtr client, const kanzi::string &type = StreamServiceClient::Type())

Creation function.

static inline kanzi::string Type()

Type accessors.

class NewBlobCallbackObserver

Public Functions

inline virtual ~NewBlobCallbackObserver()
virtual void newBlobEvent(const kanzi::string &streamId, const kanzi::string &blob, const int &flags) = 0
class NewBlobSubscription

Public Members

NewBlobCallbackFunction function
class ReceiveEncoderParameterCallbackObserver

Public Functions

inline virtual ~ReceiveEncoderParameterCallbackObserver()
virtual void receiveEncoderParameterEvent(const kanzi::string &streamId, const kanzi::string &parameterName, const kanzi::string &parameterValue) = 0
class ReceiveEncoderParameterSubscription
class ReceiveStreamInfoCallbackObserver

Public Functions

inline virtual ~ReceiveStreamInfoCallbackObserver()
virtual void receiveStreamInfoEvent(const StreamInfo &streamInfo) = 0
class ReceiveStreamInfoSubscription

Public Members

ReceiveStreamInfoCallbackFunction function
class SubscribeBlobsCompleteSubscription

Public Members

SubscribeBlobsCompleteFunction function
class SubscriptionResultCallbackObserver

Public Functions

inline virtual ~SubscriptionResultCallbackObserver()
virtual void subscriptionResultEvent(const kanzi::string &streamId, const bool &subscribed) = 0
class SubscriptionResultSubscription

Public Members

SubscriptionResultCallbackFunction function