IDanteOutputHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IDANTEOUTPUTHELPER_H
#define ZRC_IDANTEOUTPUTHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum LocalNetworkAudioChannelType
{
    LocalNetworkAudioChannelTypeUnknown = -1,   
    LocalNetworkAudioChannelTypeRX = 0,         
    LocalNetworkAudioChannelTypeTX = 1,         
};
 
enum BroadcastConnectionState
{
    BroadcastConnectionStateDisconnected = 0,   
    BroadcastConnectionStateConnected = 1,      
};
 
enum AudioSignalType
{
    AudioSignalTypeMono = 0,        
    AudioSignalTypeStereoLeft = 1,  
    AudioSignalTypeStereoRight = 2, 
};
 
enum AudioResourceType
{
    AudioResourceTypeIndividualUserAudio = 0,   
    AudioResourceTypeMixedAudio = 1,            
    AudioResourceTypeShareContentAudio = 2,     
    AudioResourceTypeGalleryMixedAudio = 3,     
    AudioResourceTypeInterpretationAudio = 4,   
    AudioResourceTypeOutputMixAudio = 5,        
 
};
 
enum SubscriptionGalleryType
{
    SubscriptionGalleryTypeNone = 0,     
    SubscriptionGalleryTypeUI = 1,       
    SubscriptionGalleryTypeCustomAV = 2, 
};
 
enum SubscriptionOutputMixType
{
    SubscriptionOutputMixTypeNone    = 0, 
    SubscriptionOutputMixTypeDisplay = 1, 
    SubscriptionOutputMixTypeNDI     = 2, 
    SubscriptionOutputMixTypeHWIO    = 3, 
};
 
struct LocalNetworkAudioChannelInfo
{
    std::string                   channelName;                                          
    int32_t                       channelID = 0;                                        
    LocalNetworkAudioChannelType  channelType = LocalNetworkAudioChannelTypeUnknown;    
    std::string                   networkDeviceName;                                    
};
 
struct LocalNetworkAudioDeviceInfo
{
    std::string                               networkDeviceName;    
    std::vector<LocalNetworkAudioChannelInfo> rxChannels;           
    std::vector<LocalNetworkAudioChannelInfo> txChannels;           
    bool                                      identifiable = false; 
};
 
struct NetworkAudioError
{
    int32_t       errorCode = 0;    
    std::string   errorName;        
};
 
struct NetworkAudioBroadcastGalleryBindInfo
{
    int32_t                 galleryPage = -1;                            
    GalleryGridSize         galleryGridSize;                             
    SubscriptionGalleryType galleryType = SubscriptionGalleryTypeNone;   
};
 
struct NetworkAudioBroadcastOutputMixBindInfo
{
    SubscriptionOutputMixType outputMixType = SubscriptionOutputMixTypeNone; 
    uint32_t                  index = 0;                                     
    uint32_t                  hwioDeviceId = 0;                              
};
 
struct NetworkAudioBroadcastConnectionInfo
{
    int32_t                                   userID = 0;                                             
    int32_t                                   languageID = -1;                                        
    AudioResourceType                         resourceType = AudioResourceTypeIndividualUserAudio;    
    AudioSignalType                           signalType = AudioSignalTypeMono;                       
    LocalNetworkAudioChannelInfo              txChannel;                                              
    BroadcastConnectionState                  state = BroadcastConnectionStateDisconnected;           
    NetworkAudioBroadcastGalleryBindInfo      galleryBindInfo;                                        
    NetworkAudioBroadcastOutputMixBindInfo    outputMixBindInfo;                                      
};
 
class IDanteOutputHelperSink
{
public:
    virtual ~IDanteOutputHelperSink() {}
 
    virtual void OnCreateLocalNetworkAudioDevice(int32_t result, const LocalNetworkAudioDeviceInfo& info) = 0;
 
    virtual void OnDestroyLocalNetworkAudioDevice(int32_t result) = 0;
 
    virtual void OnLocalNetworkAudioDeviceError(const NetworkAudioError& error) = 0;
 
    virtual void OnLocalNetworkAudioDeviceInfoNotification(const LocalNetworkAudioDeviceInfo& info) = 0;
 
    virtual void OnBindUserAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnBindUserAudioConnectionError(const NetworkAudioError& result, int32_t userID, const LocalNetworkAudioChannelInfo& channel, AudioSignalType signalType) = 0;
 
    virtual void OnUnbindUserAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnUnbindUserAudioConnectionError(const NetworkAudioError& result, int32_t userID, AudioSignalType signalType) = 0;
 
    virtual void OnBindMixedAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnBindMixedAudioConnectionError(const NetworkAudioError& result, const LocalNetworkAudioChannelInfo& channel, AudioSignalType signalType) = 0;
 
    virtual void OnUnbindMixedAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnUnbindMixedAudioConnectionError(const NetworkAudioError& result, AudioSignalType signalType) = 0;
 
    virtual void OnUnbindAllAudioConnection(const NetworkAudioError& result, const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnListAllAudioConnection(const NetworkAudioError& result, const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnUpdateAudioConnection(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnUnbindChannelAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnUnbindChannelAudioConnectionError(const NetworkAudioError& result, const LocalNetworkAudioChannelInfo& channel) = 0;
 
    virtual void OnListAllUnbindChannel(const NetworkAudioError& result, const std::vector<LocalNetworkAudioChannelInfo>& txChannels) = 0;
 
    virtual void OnBindShareContentAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnBindShareContentAudioConnectionError(const NetworkAudioError& result, const LocalNetworkAudioChannelInfo& channel, AudioSignalType signalType) = 0;
 
    virtual void OnUnbindShareContentAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnUnbindShareContentAudioConnectionError(const NetworkAudioError& result, AudioSignalType signalType) = 0;
 
    virtual void OnBindGalleryMixedAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
    virtual void OnBindGalleryMixedAudioConnectionError(const NetworkAudioError& result, const NetworkAudioBroadcastGalleryBindInfo& galleryBindInfo, const LocalNetworkAudioChannelInfo& channel) = 0;
 
    virtual void OnUnbindGalleryMixedAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
    virtual void OnUnbindGalleryMixedAudioConnectionError(const NetworkAudioError& result, const NetworkAudioBroadcastGalleryBindInfo& galleryBindInfo) = 0;
 
    virtual void OnBindInterpretationAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnBindInterpretationAudioConnectionError(const NetworkAudioError& result, int32_t languageID, const LocalNetworkAudioChannelInfo& channel) = 0;
 
    virtual void OnUnbindInterpretationAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnUnbindInterpretationAudioConnectionError(const NetworkAudioError& result, int32_t languageID) = 0;
 
    virtual void OnListAllOutputMixScreen(const NetworkAudioError& result, const std::vector<NetworkAudioBroadcastOutputMixBindInfo>& screens) = 0;
 
    virtual void OnBindOutputMixAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnBindOutputMixAudioConnectionError(const NetworkAudioError& result, const NetworkAudioBroadcastOutputMixBindInfo& outputMixBindInfo, const LocalNetworkAudioChannelInfo& channel) = 0;
 
    virtual void OnUnbindOutputMixAudioConnectionSuccess(const std::vector<NetworkAudioBroadcastConnectionInfo>& connections) = 0;
 
    virtual void OnUnbindOutputMixAudioConnectionError(const NetworkAudioError& result, const NetworkAudioBroadcastOutputMixBindInfo& outputMixBindInfo) = 0;
};
 
class IDanteOutputHelper
{
public:
    virtual ~IDanteOutputHelper() {}
 
    virtual ZRCSDKError RegisterSink(IDanteOutputHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IDanteOutputHelperSink* pSink) = 0;
 
    virtual ZRCSDKError IsSupportDanteOutput(bool& isSupport) = 0;
 
    virtual ZRCSDKError CreateLocalNetworkAudioDevice(const std::string& name, int32_t rxChannelCount = 8, int32_t txChannelCount = 8) = 0;
 
    virtual ZRCSDKError DestroyLocalNetworkAudioDevice(const std::string& name) = 0;
 
    virtual ZRCSDKError BindUserAudioConnection(int32_t userID, const LocalNetworkAudioChannelInfo& channel, AudioSignalType signalType = AudioSignalTypeMono) = 0;
 
    virtual ZRCSDKError UnbindUserAudioConnection(int32_t userID, AudioSignalType signalType) = 0;
 
    virtual ZRCSDKError BindMixedAudioConnection(const LocalNetworkAudioChannelInfo& channel, AudioSignalType signalType) = 0;
 
    virtual ZRCSDKError UnbindMixedAudioConnection(AudioSignalType signalType) = 0;
 
    virtual ZRCSDKError BindShareContentAudioConnection(const LocalNetworkAudioChannelInfo& channel, AudioSignalType signalType) = 0;
 
    virtual ZRCSDKError UnbindShareContentAudioConnection(AudioSignalType signalType) = 0;
 
    virtual ZRCSDKError BindGalleryMixedAudioConnection(const NetworkAudioBroadcastGalleryBindInfo& galleryBindInfo, const LocalNetworkAudioChannelInfo& channel) = 0;
 
    virtual ZRCSDKError UnbindGalleryMixedAudioConnection(const NetworkAudioBroadcastGalleryBindInfo& galleryBindInfo) = 0;
 
    virtual ZRCSDKError BindInterpretationAudioConnection(int32_t languageID, const LocalNetworkAudioChannelInfo& channel) = 0;
 
    virtual ZRCSDKError UnbindInterpretationAudioConnection(int32_t languageID) = 0;
 
    virtual ZRCSDKError ListAllOutputMixScreen() = 0;
 
    virtual ZRCSDKError BindOutputMixAudioConnection(const NetworkAudioBroadcastOutputMixBindInfo& outputMixBindInfo, const LocalNetworkAudioChannelInfo& channel) = 0;
 
    virtual ZRCSDKError UnbindOutputMixAudioConnection(const NetworkAudioBroadcastOutputMixBindInfo& outputMixBindInfo) = 0;
 
    virtual ZRCSDKError UnbindAllAudioConnection() = 0;
 
    virtual ZRCSDKError ListAllAudioConnection() = 0;
 
    virtual ZRCSDKError UnbindChannelAudio(const LocalNetworkAudioChannelInfo& channel) = 0;
 
    virtual ZRCSDKError ListAllUnbindChannel() = 0;
 
    virtual ZRCSDKError GetLocalNetworkAudioDeviceInfo(LocalNetworkAudioDeviceInfo& info) = 0;
};
 
NS_ZRCSDK_END
 
#endif