AppEasy Core SDK  1.5.0
Cross platform mobile and desktop app and game development SDK - The easy way to make apps
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
CzXomlActions_Media Class Reference
Actions

Implements actions that relate to media control. More...

#include <CzActionsMedia.h>

Inheritance diagram for CzXomlActions_Media:
IzXomlAction

List of all members.

Public Types

enum  eActionType {
  Action_PlaySound = 0, Action_PlayMusic = 1, Action_StopMusic = 2, Action_ChangeVideoCam = 3,
  Action_AudioEnable = 4, Action_Max = 5
}

Public Member Functions

 CzXomlActions_Media (eActionType type)
void Execute (IzXomlResource *source, CzAction *action)
 The main actions executor for media related actions. All media specific actions such as PlaySound, PlayMusic etc are implemented by this method.

Protected Member Functions

 CzXomlActions_Media ()

Protected Attributes

eActionType Type

Detailed Description

Implements actions that relate to media control.

The CzXomlActions_Media class holds Actions (IzXomlAction) that deal with media play back and control such as playing a sound effect, music or modifiying the video cam stream.

The following actions are supported:

  • PlaySound
  • PlayMusic
  • StopMusic
  • ChangeVideoCam
  • AudioEnable

The above actions have the following XOML prototypes:

  • PlaySound(sound-name, looped)
    • sound-name - sound resource name
    • looped - true if the sound should loop
  • PlayMusic(filename, repeat_count)
    • filename - Name of the file that contains the music
    • repeat-count - Total number of tims to repeat play back (0 - forever)
  • StopMusic()
  • ChangeVideoCam(videocam-name, command)
    • videocam-name - Name of VideoCam resource to change
    • command - Command to use to change video cam (start or stop)
  • AudioEnable(music_enable, sounds_enable)

For more information on audio playback see CzAudio and for more information on VideoCam see CzVideoCam

Member Enumeration Documentation

enum CzXomlActions_Media::eActionType
Enumerator:
Action_PlaySound 
Action_PlayMusic 
Action_StopMusic 
Action_ChangeVideoCam 
Action_AudioEnable 
Action_Max 

Constructor & Destructor Documentation

CzXomlActions_Media::CzXomlActions_Media ( ) [inline, protected]
CzXomlActions_Media::CzXomlActions_Media ( eActionType  type) [inline]

Member Function Documentation

void CzXomlActions_Media::Execute ( IzXomlResource *  source,
CzAction *  action 
) [virtual]

The main actions executor for media related actions. All media specific actions such as PlaySound, PlayMusic etc are implemented by this method.

Parameters:
[in]source- The source of the action
[in]action- The action to execute

Implements IzXomlAction.

Member Data Documentation

eActionType CzXomlActions_Media::Type [protected]
The documentation for this class was generated from the following files: