tommyh/player_sdk.md

## player_sdk.md

      
    Raw
  

              player_sdk.md
            
          
    Get all players

var allPlayers = TOUT.players.getAll();
Get all players with a specific type

var topArticlePlayers = TOUT.players.byProductName(TOUT.PRODUCTS.TOP_ARTICLE);
var midArticlePlayers = TOUT.players.byProductName(TOUT.PRODUCTS.MID_ARTICLE);
Player Functions/Properties


play()
pause()
mute()
unmute()
tout
instanceID
productName

Example: Pause the top article player

var topArticlePlayers = TOUT.players.byProductName(TOUT.PRODUCTS.TOP_ARTICLE);
if(topArticlePlayers.length > 0){
  topArticlePlayers[0].pause();
}
Example: Get metadata for a tout

var topArticlePlayers = TOUT.players.byProductName(TOUT.PRODUCTS.TOP_ARTICLE);
if(topArticlePlayers.length > 0){
  var tout = topArticlePlayers[0].tout;
  alert("User: " + tout.user.username + "; Created at: " + tout.created_at + ", Text: " + tout.text);
}