SMPA Setup Guide
December 2, 2022 Scala, Inc. Page | 77
player_add_group(plr, groupname, baseurl=None, authstr=None)
Add Player object to Group by name.
Arguments:
plr Player Transfer Object or dict, e.g.:
{'id': 123, 'name': 'player1'}
groupname Group name.
baseurl Base URL to Content Manager (SOAP only)
authstr "user:pwd" credential string. (SOAP only)
Returns:
True on success.
None on failure.
player_create(name, baseurl, authstr, query=True, desc='', enabled=True)
Creates a Player object in Content Manager, with the given name.
Arguments:
name Player name
baseurl Base URL to Content Manager
authstr "user:pwd" credential string.
query Switch to player_query() if Player object already
exists, or other error occurs.
desc Player object description.
enabled Player is allowed to download and run content.
Returns:
Player's Transfer Object on success.
None on failure, e.g. if query=False and Player already exists.
player_query_file(name, baseurl, authstr, network)
Query Content Manager via WEBDAV for an existing Player object by name.
Arguments:
name Player name, must be enabled in CM.
baseurl Base URL to Content Manager
authstr "user:pwd" Player (not webservice) credential string.
network CM network.
Returns:
Player Object on success.
None on failure.
player_query_name(baseurl, authstr, network)
Looks up PlayerName in Player config files, then queries Content
Manager via WEBDAV for an existing Player object with that name.
Arguments:
baseurl Base URL to Content Manager
authstr "user:pwd" Player (not webservice) credential str.
network CM network.