iaudioencoder.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/broadcast/broadcasttypes.h"
#include "twitchsdk/broadcast/iaudioframereceiver.h"

namespace ttv
{
    namespace broadcast
    {       
        class IFrameWriter;
        class IAudioEncoder;
        class AudioFrame;
        struct AudioParams;
    }
}


struct ttv::broadcast::AudioParams
{
    AudioParams();

    uint32_t numInputAudioLayers; // The number of audio capturers that will be submitting audio to the mixer.
    uint32_t numChannels; // The number of audio channels.
    uint32_t encodedSampleRate; // The samples per second that should come out of the audio encoder.
};


class ttv::broadcast::IAudioEncoder
{
public:
    IAudioEncoder();
    virtual ~IAudioEncoder();

public:
    virtual TTV_ErrorCode SetFrameWriter(const std::shared_ptr<IFrameWriter>& frameWriter) = 0;
    virtual TTV_ErrorCode GetAudioEncodingFormat(AudioFormat& result) = 0;
    virtual std::string GetName() const = 0;
    virtual TTV_ErrorCode Initialize() = 0;
    virtual TTV_ErrorCode Start(uint32_t streamIndex, const AudioParams& audioParams) = 0;
    virtual TTV_ErrorCode GetNumInputSamplesPerEncodeFrame(uint32_t& result) = 0;
    virtual TTV_ErrorCode Stop() = 0;
    virtual TTV_ErrorCode Shutdown() = 0;

    virtual TTV_ErrorCode SubmitFrame(const std::shared_ptr<AudioFrame>& audioFrame) = 0;
    template <typename T> bool SupportsReceiverProtocol() const { return SupportsReceiverProtocol(T::GetReceiverTypeId()); }
    virtual bool SupportsReceiverProtocol(IAudioFrameReceiver::ReceiverTypeId typeId) const = 0;
    virtual std::shared_ptr<IAudioFrameReceiver> GetReceiverImplementation(IAudioFrameReceiver::ReceiverTypeId typeId) = 0;
};