Script syntaxe
Un article de XMIX.
(Différences entre les versions)
Version du 27 avril 2007 à 22:24 Yoann (Discuter | contribs) ← Différence précédente |
Version du 3 mai 2007 à 23:11 Yoann (Discuter | contribs) Différence suivante → |
||
Ligne 1: | Ligne 1: | ||
- | '''<time_code>:<variable>:<instruction>[:<param> [:<parma2> ... :<param n>]]''' | + | == Général == |
+ | Un instruction est composé de la manière suivante | ||
+ | |||
+ | '''<time_code>:<variable>:<instruction>[:<param> [:<parma2> ... :<param n>]]''' | ||
tous doit tenir sur un ligne (les retours chariots délimité chaque instruction). | tous doit tenir sur un ligne (les retours chariots délimité chaque instruction). | ||
- | '''<time_code>''' : il est existe de trois types différents : | + | == <time_code> == |
+ | Il est existe de trois types différents : | ||
'''<n>''' : Time code absolu, l'instruction sera déclanchée n miliseconde(s) après le démarrage du player. | '''<n>''' : Time code absolu, l'instruction sera déclanchée n miliseconde(s) après le démarrage du player. | ||
(Ex: 12000:A:CREATECHANNEL) | (Ex: 12000:A:CREATECHANNEL) | ||
Ligne 10: | Ligne 14: | ||
'''+<n>''' : Time code relatif incrémental. Cette instruction sera exécutée n miliseconde(s) après la dernière | '''+<n>''' : Time code relatif incrémental. Cette instruction sera exécutée n miliseconde(s) après la dernière | ||
instruction de type relatif incrémental ou de type relatif temps réel.(Ex: +500:A:CREATECHANNEL) | instruction de type relatif incrémental ou de type relatif temps réel.(Ex: +500:A:CREATECHANNEL) | ||
- | petit raccourci : *: -> immédiat et equivalent à *0 | + | '''CREATECHANNEL''' : Créer un objet de type stream |
+ | *:<NomAudioGroup>:CREATECHANNEL:<NomCanal> petit raccourci : *: -> immédiat et equivalent à *0 | ||
- | '''<variable>''' : Chemin pour accéder à l'objet | + | == <variable> == |
+ | Chemin pour accéder à l'objet: | ||
'''*''' : Self (généralement la session) | '''*''' : Self (généralement la session) | ||
'''_SYS_''' : Correspondant aux instruction qui porte sur le système (Ex: *:_SYS_:EXIT) | '''_SYS_''' : Correspondant aux instruction qui porte sur le système (Ex: *:_SYS_:EXIT) | ||
Ligne 18: | Ligne 24: | ||
exemple: /Session1/AG1/Channel1 ou AG1/Channel1 | exemple: /Session1/AG1/Channel1 ou AG1/Channel1 | ||
- | '''<instruction>''': | + | == <instruction> : objet type Session == |
- | '''NOP''' : Ne fait rien ! | + | |
'''CREATEAUDIOGROUP''' : Créer un AudioGroup | '''CREATEAUDIOGROUP''' : Créer un AudioGroup | ||
*:<session>:CREATEAUDIOGROUP:<NomAudioGroup> | *:<session>:CREATEAUDIOGROUP:<NomAudioGroup> | ||
+ | '''FREE:<Obj>''' : Suprime un objet et sa décendance | ||
+ | |||
+ | == <instruction> : objet type AudioGroup == | ||
'''CREATECHANNEL''' : Créer un objet de type stream | '''CREATECHANNEL''' : Créer un objet de type stream | ||
*:<NomAudioGroup>:CREATECHANNEL:<NomCanal> | *:<NomAudioGroup>:CREATECHANNEL:<NomCanal> | ||
+ | '''FREE:<Obj>''' : Suprime un objet et sa décendance | ||
+ | '''SETVOL:<vol>''' : Modifie le volume de l'objet (0-255) | ||
+ | '''SETPAN:<pan>''' : Modifie la répartition du son entre gauche/droite en stéréo (0 à droite, 255 à gauche) | ||
+ | '''SETMUTE:[ON|OFF] : Active le mode mute | ||
+ | |||
+ | == <instruction> : objet type Channel == | ||
+ | |||
'''SETFILEID:<ID>''' : Affecte un fichier représenté par <ID> à l'objet de type stream | '''SETFILEID:<ID>''' : Affecte un fichier représenté par <ID> à l'objet de type stream | ||
*:<NomCanal>:SETFILEID:<ID> | *:<NomCanal>:SETFILEID:<ID> | ||
Ligne 35: | Ligne 50: | ||
'''SETVOL:<vol>''' : Modifie le volume de l'objet (0-255) | '''SETVOL:<vol>''' : Modifie le volume de l'objet (0-255) | ||
'''SETPAN:<pan>''' : Modifie la répartition du son entre gauche/droite en stéréo (0 à droite, 255 à gauche) | '''SETPAN:<pan>''' : Modifie la répartition du son entre gauche/droite en stéréo (0 à droite, 255 à gauche) | ||
+ | |||
+ | '''SETMONITOR:<type>:[ON|OFF] : Active le monitoring de la variable pour le client puisse accéder rapidement au données semi/temps réel | ||
To be continued... | To be continued... |
Version du 3 mai 2007 à 23:11
Sommaire |
Général
Un instruction est composé de la manière suivante
<time_code>:<variable>:<instruction>[:<param> [:<parma2> ... :<param n>]]
tous doit tenir sur un ligne (les retours chariots délimité chaque instruction).
<time_code>
Il est existe de trois types différents :
<n> : Time code absolu, l'instruction sera déclanchée n miliseconde(s) après le démarrage du player. (Ex: 12000:A:CREATECHANNEL) *<n> : Time code relatif temps réel. L'instruction sera déclanchée n miliseconde(s) après son interprétation. (Ex: *1000:A:CREATESRTEAM) +<n> : Time code relatif incrémental. Cette instruction sera exécutée n miliseconde(s) après la dernière instruction de type relatif incrémental ou de type relatif temps réel.(Ex: +500:A:CREATECHANNEL) CREATECHANNEL : Créer un objet de type stream *:<NomAudioGroup>:CREATECHANNEL:<NomCanal> petit raccourci : *: -> immédiat et equivalent à *0
<variable>
Chemin pour accéder à l'objet:
* : Self (généralement la session) _SYS_ : Correspondant aux instruction qui porte sur le système (Ex: *:_SYS_:EXIT) <variable_path> : Correspond à un chemin absolu ou relatif pour accéder à un objet. exemple: /Session1/AG1/Channel1 ou AG1/Channel1
<instruction> : objet type Session
CREATEAUDIOGROUP : Créer un AudioGroup *:<session>:CREATEAUDIOGROUP:<NomAudioGroup> FREE:<Obj> : Suprime un objet et sa décendance
<instruction> : objet type AudioGroup
CREATECHANNEL : Créer un objet de type stream *:<NomAudioGroup>:CREATECHANNEL:<NomCanal> FREE:<Obj> : Suprime un objet et sa décendance SETVOL:<vol> : Modifie le volume de l'objet (0-255) SETPAN:<pan> : Modifie la répartition du son entre gauche/droite en stéréo (0 à droite, 255 à gauche) SETMUTE:[ON|OFF] : Active le mode mute
<instruction> : objet type Channel
SETFILEID:<ID> : Affecte un fichier représenté par <ID> à l'objet de type stream *:<NomCanal>:SETFILEID:<ID> PLAY : Commence la lecture *:<NomCanal>:PLAY PAUSE : Met en pause la lecture *:<NomCanal>:PAUSE STOP : Arrête la lecture *:<NomCanal>:STOP SETPOS:<position> : Deplace le curseur de lecture à la position indiquée. SETVOL:<vol> : Modifie le volume de l'objet (0-255) SETPAN:<pan> : Modifie la répartition du son entre gauche/droite en stéréo (0 à droite, 255 à gauche)
SETMONITOR:<type>:[ON|OFF] : Active le monitoring de la variable pour le client puisse accéder rapidement au données semi/temps réel
To be continued...