a1200   NEWS   APPS   DOCS   ABOUT
a1200
----
a1200
----
Autodocs
 Libraries:
 realtime.library
  CreatePlayer
  DeletePlayer
  ExternalSync
  FindConductor
  GetPlayerAttrsA
  LockRealTime
  NextConductor
  SetConductorState
  SetPlayerAttrs
  UnlockRealTime
Include
GuruMeditation
Docs » Autodocs » realtime.library » SetPlayerAttrs

NAME

	SetPlayerAttrsA -- set the attributes of a player. (V37)
SetPlayerAttrs -- varargs stub for SetPlayerAttrsA(). (V37)

SYNOPSIS

	result = SetPlayerAttrsA(player, tagList);
D0 A0 A1
BOOL SetPlayerAttrsA(struct Player *, struct TagItem *);
result = SetPlayerAttrs(player,firstTag, ...);
BOOL SetPlayerAttrs(struct Player *, Tag, ...);

FUNCTION

	Changes the attributes of the specified player, according to the
attributes chosen in the tag list. If an attribute is not provided
in the tag list, its value remains unchanged.

INPUTS

	player - player to set the attributes of.
tagList - pointer to an array of tags specifying the attributes
to change, or NULL.

TAGS

	PLAYER_Name (STRPTR) - name of the player (generally the
application's name). (V37)
PLAYER_Hook (struct Hook *) - function to call when time changes
occur. The Hook is called
with:
A0 - address of Hook structure
A1 - message, currently pmTime or pmState
A2 - address of Player structure
Note that your hook function is not necessarily called
TICK_FREQ times per second. This is the maximum number
of times it can be called. (V37)
PLAYER_Priority (BYTE) - priority for the player, from -128 to +127.
(V37)
PLAYER_Conductor (STRPTR) - name of the conductor to link with. If
NULL, delink from conductor. (V37)
PLAYER_Ready (BOOL) - set/clear the "ready" flag. (V37)
PLAYER_AlarmTime (LONG) - sets this player's alarm time, and the
PLAYERF_ALARMSET flag. (V37)
PLAYER_Alarm (BOOL) - if TRUE sets the PLAYERF_ALARMSET flag, FALSE
clears the flag. (V37)
PLAYER_AlarmSigTask (struct Task *) - task to signal on notify or
alarm. Setting this to NULL automatically clears the
PLAYERF_ALARMSET flag. (V37)
PLAYER_AlarmSigBit (BYTE) - signal bit to use on alarm or -1 to
disable. Setting this to -1 automatically clears the
PLAYERF_ALARMSET. (V37)
PLAYER_Quiet (BOOL) - when TRUE, this player is ignored. Mainly
used by external sync applications. (V37)
PLAYER_UserData (VOID *) - sets this player's UserData value. (V37)
PLAYER_ID (UWORD) - sets this player's ID value. (V37)
PLAYER_Conducted (BOOL) - if TRUE sets the PLAYERF_CONDUCTED flag,
FALSE clears the flag. (V37)
PLAYER_ExtSync (BOOL) - if TRUE, attempt to become external sync
source. If FALSE, release external sync. (V37)
PLAYER_ErrorCode (LONG *) - optional pointer to a longword which
will receive an error code whenever this function
fails. Possible error values currently include:
RTE_NOMEM - memory allocation failed
RTE_NOTIMER - timer (CIA) allocation failed

RESULT

	result - TRUE if all went well, FALSE if there was an error.
When an error occurs, an error code can be returned
in the longword variable pointed to by the optional
PLAYER_ErrorCode tag.

SEE ALSO

CreatePlayer(), DeletePlayer(), GetPlayerAttrs

Comments

Name:
E-mail: Use this if you want a message if you get a response, will not be shown.
Comment:
Select correct short for:

Spaceballs

DJ
RSI
PDX
SPB

Comments:

$VER: d0.se 1.14 Copyright © 2011-2020 Tobias Geijersson support at d0 dot se