"No one can be told what GeeXLab is, you have to see it for yourself!"

"Stop Playing Games and Start Making Them! With GeeXLab, your are on your way!"


Quick Links
What is GeeXLab
Download GeeXLab
GeeXLab Requirements
Online Help
Articles and Tutorials
Samples Screenshots
Videos

GeeXLab Changelog

XML Ref. Guide
Scripting Ref. Guide
Code Samples

Purchase GeeXLab
GeeXLab SDK

Shader Library

Follow GeeXLab's News
GeeXLab news, articles, tutorials and demos @ Geeks3D.com
GeeXLab @ Twitter GeeXLab RSS Feed

Subscribe to GeeXLab news by email

[ Back to Geeks3D.com ]

GeeXLab

GeeXLab

Laboratory for Real Time 3D Programming (prototyping and demos)
OpenGL, Lua, Python, GLSL,
PhysX and more...

Reference Guide
Host-API Lua / Python



Back to Homepage
Back to Developer's Guide Index

HYP_Playlist Library


Description
Manages play lists.

Number of functions: 10

HYP_Playlist.Create

Description
Create allows to create a new playlist.

Languages:

Parameters
  • name [STRING]: Name of the playlist.

    Return Values
  • id [INTEGER]: Playlist identifier

    Code sample :

    id = HYP_Playlist.Create( name )


    HYP_Playlist.Destroy

    Description
    Destroy allows to destroy a playlist.

    Languages:

    Parameters
  • id [INTEGER]: Playlist identifier

    Code sample :

    HYP_Playlist.Destroy( id )


    HYP_Playlist.AddTrack

    Description
    AddTrack allows to add an audio track to a playlist.

    Languages:

    Parameters
  • id [INTEGER]: Playlist identifier
  • soundtrack_id [INTEGER]: identifier of the soudtrack. This identifier may have been changed wether in the XML code or by the HYP_Sound.Load() function.

    Code sample :

    id_pl = HYP_Playlist.Create( "myCoolPlaylist" );
    id_st1 = HYP_Playlist.AddTrack( id_pl, "data/mp3/first.mp3" );
    id_st2 = HYP_Playlist.AddTrack( id_pl, "data/mp3/second.mp3" );
    HYP_Playlist.Play( id_pl );


    HYP_Playlist.RemoveTrack

    Description
    RemoveTrack to remove an audio track from a playlist.

    Languages:

    Parameters
  • id [INTEGER]: Playlist identifier
  • soundtrack_id [INTEGER]: Soundtrack identifier.

    Code sample :

    HYP_Playlist.RemoveTrack( id, soundtrack_id )


    HYP_Playlist.SetCurrentTrack

    Description
    SetCurrentTrack allows to change audio track for playing.

    Languages:

    Parameters
  • id [INTEGER]: Playlist identifier
  • soundtrack_id [INTEGER]: identifier of the soudtrack. This identifier may have been changed wether in the XML code or by the HYP_Sound.Load() function.

    Code sample :

    HYP_Playlist.SetCurrentTrack( id, soundtrack_id )


    HYP_Playlist.GetCurrentTrackId

    Description
    GetCurrentTrackId allows to get the identifier of the current playing audio track.

    Languages:

    Parameters
  • id [INTEGER]: Playlist identifier

    Return Values
  • id_st [INTEGER]: identifier of current soundtrack playing.

    Code sample :

    id_st = HYP_Playlist.GetCurrentTrackId( id )


    HYP_Playlist.GetCurrentTrackName

    Description
    GetCurrentTrackName allows to get the name of the current playing audio track.

    Languages:

    Parameters
  • id [INTEGER]: Playlist identifier

    Return Values
  • name_st [STRING]: Name of soundtrack. playing

    Code sample :

    name_st = HYP_Playlist.GetCurrentTrackName( id )


    HYP_Playlist.Play

    Description
    Play allows to start playing audio track from the playlist.

    Languages:

    Parameters
  • id [INTEGER]: identifier of the playlist.

    Code sample :

    HYP_Playlist.Play( id )


    HYP_Playlist.Stop

    Description
    Stop allows to stop playing audio track from the playlist.

    Languages:

    Parameters
  • id [INTEGER]: identifier of the playlist.

    Code sample :

    HYP_Playlist.Stop( id )


    HYP_Playlist.SetOptions

    Description
    SetOptions allows to change the working mode of the playlist.

    Languages:

    Parameters
  • options [INTEGER]: playlist options: PLAYLIST_TRACKS_MANAGEMENT_OFF = 1 PLAYLIST_TRACKS_MANAGEMENT_ON = 2 PLAYLIST_LOOP_ON = 3 PLAYLIST_LOOP_OFF = 4 PLAYLIST_DISPLAY_CUR_TRACK_NAME_ON = 6 PLAYLIST_DISPLAY_CUR_TRACK_NAME_OFF = 7 PLAYLIST_ENABLED = 8 PLAYLIST_DISABLED = 9 These options are 'problem-free' except for PLAYLIST_TRACKS_MANAGEMENT_ON/PLAYLIST_TRACKS_MANAGEMENT_OFF. PLAYLIST_TRACKS_MANAGEMENT_ON let Demoniak manage the different audio track transitions. It is the default value. PLAYLIST_TRACKS_MANAGEMENT_OFF requires to use afterwards HYP_Sound.IsTrackFinished() and other functions from the HYP_Sound lib to manage oneself the audio file playing. - Values = PLAYLIST_TRACKS_MANAGEMENT_OFF = 1| PLAYLIST_TRACKS_MANAGEMENT_ON = 2| PLAYLIST_LOOP_ON = 3| PLAYLIST_LOOP_OFF = 4| PLAYLIST_DISPLAY_CUR_TRACK_NAME_ON = 6| PLAYLIST_DISPLAY_CUR_TRACK_NAME_OFF = 7| PLAYLIST_ENABLED = 8| PLAYLIST_DISABLED = 9
  • id [INTEGER]: identifier of the playlist.

    Code sample :

    HYP_Playlist.SetOptions( id, options )




  • Random Projects

    Dream Vision Effect
    Dream Vision Effect

    2D Shockwave Effect
    2D Shockwave Effect

    Night Vision PostFX
    Night Vision PostFX


    Random Code Samples

    Software Mesh Instancing
    Software Mesh Instancing

    Hierarchy
    Hierarchy

    Texture - Video AVI
    Texture - Video AVI



    (C)2009-2010 Geeks3D.com