iingesttester.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/core/component.h"
#include <functional>
#include <memory>

namespace ttv
{
    namespace broadcast
    {
        class IIngestTester;
        class IVideoEncoder;
    }
}

class ttv::broadcast::IIngestTester
{
public:
    enum class TestState
    {
        Stopped,                // Start has not yet been called
        Connecting,             // Connecting to the ingest server
        Testing,                // Testing the server
        Disconnecting,          // Disconnecting from the server
        Finished,               // Successfully finished the testing
        Failed                  // The test failed for some reason and has stopped
    };

public:
    virtual ~IIngestTester();
    virtual TTV_ErrorCode GetTestState(TestState& result) const = 0;
    virtual TTV_ErrorCode GetIngestServer(IngestServer& result) const = 0;
    virtual TTV_ErrorCode Start(const IngestServer& ingestServer) = 0;
    virtual TTV_ErrorCode Cancel() = 0;
    virtual TTV_ErrorCode GetMeasuredKbps(uint32_t& result) = 0;
    virtual TTV_ErrorCode GetTestError(TTV_ErrorCode& result) = 0;
    virtual TTV_ErrorCode SetTestDurationMilliseconds(uint64_t duration) = 0;
    virtual TTV_ErrorCode GetTestDurationMilliseconds(uint64_t& result) const = 0;
    virtual TTV_ErrorCode GetProgress(float& result) const = 0;
    virtual TTV_ErrorCode GetUserId(UserId& result) const = 0;
};