twitchapi.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/core/component.h"
#include "twitchsdk/broadcast/broadcasttypes.h"
#include <string>

namespace ttv
{
    namespace broadcast
    {
        class TwitchAPI;
        class MatchGameNamesTask;
    }
}


class ttv::broadcast::TwitchAPI : public ttv::Component
{
public:
    TwitchAPI();
    TwitchAPI(const std::shared_ptr<User>& user);

    static std::string GetComponentName() { return "ttv::TwitchAPI"; }
    
    virtual std::string GetLoggerName() const override;

public:
    struct ChannelInfo
    {
        std::string streamKey;
        std::string loginName;
        std::string displayName;
        std::string url;
    };

    enum
    {
        kDefaultRequestTimeoutInSec = 10
    };

    enum MetaDataEventClass
    {
        METADATA_ACTION,
        METADATA_START,
        METADATA_END,
    };


public:
    static const char* CurrentApiVersionString();
    
public:
    typedef std::function<void(TwitchAPI* source, TTV_ErrorCode ec, ChannelInfo&& result)> GetChannelInfoCallback;
    TTV_ErrorCode GetChannelInfo(GetChannelInfoCallback&& callback);
        
    typedef std::function<void(TwitchAPI* source, TTV_ErrorCode ec)> SetStreamInfoCallback;
    TTV_ErrorCode SetStreamInfo(ChannelId channelId, const std::string& streamTitle, const std::string& gameName, SetStreamInfoCallback&& callback);

    typedef std::function<void(TwitchAPI* source, TTV_ErrorCode ec, const std::shared_ptr<StreamInfo>& result)> GetStreamInfoCallback;
    TTV_ErrorCode GetStreamInfo(ChannelId channelId, GetStreamInfoCallback&& callback);

    typedef std::function<void(TwitchAPI* source, TTV_ErrorCode ec, const std::shared_ptr<ArchivingState>& result)> GetChannelRecordingStatusCallback;
    TTV_ErrorCode GetChannelRecordingStatus(GetChannelRecordingStatusCallback&& callback);

    typedef std::function<void(TwitchAPI* source, TTV_ErrorCode ec)> RunCommercialCallback;
    TTV_ErrorCode RunCommercial(ChannelId channelId, uint32_t timeBreakSeconds, RunCommercialCallback&& callback);

    typedef std::function<void(TwitchAPI* source, const std::string& str, TTV_ErrorCode ec, const std::shared_ptr<GameInfoList>& result)> GetGameNameListCallback;
    TTV_ErrorCode GetGameNameList(const std::string& str, GetGameNameListCallback&& callback);

    typedef std::function<void(TwitchAPI* source, TTV_ErrorCode ec, std::vector<IngestServer>&& result)> GetIngestServerListCallback;
    TTV_ErrorCode GetIngestServerList(GetIngestServerListCallback&& callback);

private:
    std::weak_ptr<User> mUser;
    std::shared_ptr<MatchGameNamesTask> mOutstandingMatchGameNamesTask;
    std::string mNextGameNamesQuery;
    GetGameNameListCallback mNextGameNamesCallback;
};