wxMediaCtrl

wxMediaCtrl

wxMediaCtrl is a class for displaying types of media, such as videos, audio files, natively through native codecs.

Creation Parameters
Functions/Procedures
Supertopics

wxMediaCtrl

[func]
get_media_length
( atom media )

Category: wxMediaCtrl

Obtains the length - the total amount of time the movie has in milliseconds.


wxMediaCtrl

[func]
get_media_position
( atom media )

Category: wxMediaCtrl

Obtains the current position in time within the movie in milliseconds.


wxMediaCtrl

[func]
get_media_state
( atom media )

Category: wxMediaCtrl

Obtains the state the playback of the media is in -


wxMediaCtrl

[func]
get_media_volume
( atom media )

Category: wxMediaCtrl

Gets the volume of the media from a 0.0 to 1.0 range. Note that due to rounding and other errors this may not be the exact value sent to set_media_volume.


wxMediaCtrl

[func]
load_media
( atom media, sequence fileName )

Category: wxMediaCtrl

Loads the file that fileName refers to. Returns false if loading fails.


wxMediaCtrl

[func]
load_media_uri
( atom media, object uri )

Category: wxMediaCtrl

Loads the location that uri refers to. Note that this is very implementation-dependant, although HTTP URI/URLs are generally supported, for example. Returns false if loading fails.


wxMediaCtrl

[func]
pause_media
( atom media )

Category: wxMediaCtrl

Pauses playback of the movie.


wxMediaCtrl

[func]
play_media
( atom media )

Category: wxMediaCtrl

Resumes playback of the movie.


wxMediaCtrl

[proc]
seek_media
( atom media, atom where, atom mode )

Category: wxMediaCtrl

Seeks to a position within the movie.


wxMediaCtrl

[func]
set_media_volume
( atom media, atom volume )

Category: wxMediaCtrl

Sets the volume of the media from a 0.0 to 1.0 range to that referred by dVolume. 1.0 represents full volume, while 0.5 represents half (50 percent) volume, for example. Note that this may not be exact due to conversion and rounding errors, although setting the volume to full or none is always exact. Returns true if successful.


wxMediaCtrl

[func]
show_player_controls
( atom media, integer flags )

Category: wxMediaCtrl

A special feature to wxMediaCtrl. Applications using native toolkits such as QuickTime usually have a scrollbar, play button, and more provided to them by the toolkit. By default wxMediaCtrl does not do this. However, on the directshow and quicktime backends you can show or hide the native controls provided by the underlying toolkit at will using ShowPlayerControls. Simply calling the function with default parameters tells wxMediaCtrl to use the default controls provided by the toolkit. The function takes a wxMediaCtrlPlayerControls enumeration as follows:


wxMediaCtrl

[func]
stop_media
( atom media )

Category: wxMediaCtrl

Stops the media.