Skip to content

Latest commit

 

History

History
172 lines (156 loc) · 7.05 KB

configuration.md

File metadata and controls

172 lines (156 loc) · 7.05 KB
Raw

Configuration

Set Description
Twitch Credentials This is your set of API credentials for use in authenticated calls or in use with generating tokens
Config Options This is the set of options that control how the interface works and what options are enabled/diabled

Twitch Credentials

Variable Default Value Type Description
$twitch_clientKey '' String Defines the Twitch value client_key
$twitch_clientSecret '' String Defines the Twitch value client_secret
$twitch_clientUrl '' String Defines the Twitch value client_uri

All of these values are empty strings by default and can be easily chaged to be a string with a space or any value as a short-circuit to allow the interface to bypass its credential check. in order to use the interface you MUST either add any value into each of the 3 strings or add your credentials in order to perform all generation calls.

Config options

This is a list of all configuration options found in the interface between lines 36 to 56.

$twitch_DebugLevels

Level Description
FINE Sets the output functions to only accept initialization output.
FINER Sets the output functions to output initialization output and any variable updates or checks
FINEST Sets the output functions to accept all output EXCEPT raw returns
ALL Sets the output functions to accept all output including raw returns. This is NOT a recommended setting unless you are using it for specific debugging.

$twitch_configuration

Name Default Value Type Description
CALL_LIMIT_SETTING CALL_LIMIT_MAX String Set limit for the number of returns in one call, used to seperate calls out into segments of a specified length. Accepted values are CALL_LIMIT_DEFAULT, CALL_LIMIT_DOUBLE and CALL_LIMIT_MAX.
KEY_NAME name String This sets the interface keys to either name or display_name, or even any key that you wish the interface to use. It is safer to use name as your key as this is a static key to use and needs to be change by a Twitch staff member.
DEFAULT_TIMEOUT 5 Integer This sets the default time, in seconds, to await for a successful connection to the Twitch Kraken API servers. This does not affect how long the interface will await to finish recieving data from Twitch, only the time to establish a connection.
DEFAULT_RETURN_TIMEOUT 20 Integer This sets the default time, in seconds, to wait to finish downloading data from thw Twitch Kraken API servers. This does not affect how long the interface will await for a connection to the Twitch servers, only how long it will wait while recieving data.
API_VERSION 3 Integer This sets what version of the API to use from the Twitch Kraken API servers. This is set in the header and can affect returns. Currently ONLY tested with V3, but will soon accept all V2 calls as well.
TOKEN_SEND_METHOD HEADER String This sets how an OAuth token is sent to validate authenticated calls. Accepts either HEADER or QUERY. It is recommended that you always use HEADER.
RETRY_COUNTER 3 Integer This sets how many times the interface will attemppt tp rety a call in iteration before giving up. This will accept any integer.
DEBUG_SUPPRESSION_LEVEL $twitch_debugLevels['FINE'] Array[Key] This sets what debug suppression level that the interface will use when checking what output is passed to the user defined functions. This accepts one of four values: $twitch_debugLevels['FINE'], $twitch_debugLevels['FINER'], $twitch_debugLevels['FINEST'] and $twitch_debugLevels['ALL']
CERT_PATH '' String This sets the path to your supplied certificate, either self-signed or corperate signed. When this is set, changes ALL cURL calls to use true HTTPS and will validate self and peer.
CALL_LIMIT_DEFAULT 25 String This sets the upper limit of any single call to 25. This is a value that should NOT be changed under any circumstances unless you know how Twitch handles its limits.
CALL_LIMIT_DOUBLE 50 String This sets the upper limit of any single call to 50. This is a value that should NOT be changed under any circumstances unless you know how Twitch handles its limits.
CALL_LIMIT_MAX 100 String This sets the upper limit of any single call to 100. This is a value that should NOT be changed under any circumstances unless you know how Twitch handles its limits.