Twitch SDK (Internal)
Classes | Public Member Functions | Private Attributes | List of all members
ttv::chat::BitsConfiguration Class Reference

#include <chattypes.h>

Classes

struct  Action
 
struct  BitsImage
 
struct  ImageTier
 

Public Member Functions

 BitsConfiguration (const std::vector< Action > &actions, ChannelId channelId)
 
 BitsConfiguration ()
 
TTV_ErrorCode GetBitsImageUrl (const std::string &prefix, uint32_t numBits, const std::string &animation, const std::string &background, float scale, std::string &url, Color &color) const
 
const std::vector< Action > & GetActions () const
 Getter for mActions. More...
 
ChannelId GetChannelId () const
 Getter for mChannelId. More...
 

Private Attributes

std::vector< ActionmActions
 Holds the individual bits actions that can be performed. More...
 
ChannelId mChannelId
 A ChannelId of 0 implies a global bits configuration. More...
 

Detailed Description

BitsConfiguration - Describes the various bits actions and config info for them

Constructor & Destructor Documentation

◆ BitsConfiguration() [1/2]

ttv::chat::BitsConfiguration::BitsConfiguration ( const std::vector< Action > &  actions,
ChannelId  channelId 
)

◆ BitsConfiguration() [2/2]

ttv::chat::BitsConfiguration::BitsConfiguration ( )

Member Function Documentation

◆ GetActions()

const std::vector<Action>& ttv::chat::BitsConfiguration::GetActions ( ) const

Getter for mActions.

◆ GetBitsImageUrl()

TTV_ErrorCode ttv::chat::BitsConfiguration::GetBitsImageUrl ( const std::string &  prefix,
uint32_t  numBits,
const std::string &  animation,
const std::string &  background,
float  scale,
std::string &  url,
Color color 
) const

Returns the bits image URL and the color given various config arguments Returns: TTV_EC_SUCCESS if found and copies into result. TTV_EC_NOT_AVAILABLE if we can't find a URL that match the given config arguments

◆ GetChannelId()

ChannelId ttv::chat::BitsConfiguration::GetChannelId ( ) const

Getter for mChannelId.

Member Data Documentation

◆ mActions

std::vector<Action> ttv::chat::BitsConfiguration::mActions
private

Holds the individual bits actions that can be performed.

◆ mChannelId

ChannelId ttv::chat::BitsConfiguration::mChannelId
private

A ChannelId of 0 implies a global bits configuration.


The documentation for this class was generated from the following file: