Media
From ActiveWiki
The media command enables media player functionality within a scene for playback of local- and web-based media files, as well as broadcast streams. All file formats which are supported by your installed version of Windows Media Player will be supported in Activeworlds, except play-lists. However, this does not guarantee all users will be able to support all listed formats with a clean installation of Windows Media Player. Windows Media metafiles (.asx, .wax, .wvx, .wmx, .wpl) are not supported.
Note: Windows Media Player 9 is recommended for best performance. Some media content cannot be displayed correctly on older players, due to missing format decompression support
Contents |
[edit] Usage
media url=url ["Info text"] [name=name] [set OR pause OR stop] [color=color] [bcolor=bcolor] [res=res]
[fx=fx] [radius=radius] [radoff=radoff] [vol=vol] [loop=loop] [osd=osd] [ext=ext] [nostop]
[edit] Description
Sign or picture objects must be used to show the video frames of the media.
[edit] Required Arguments
[edit] URL
The URL command, the only required argument, specifies the url, web-address or path to the media file. If the url is empty and a name is specified, it will stop running media on all objects of the triggered object's owner within the current view range. The url-prefix defaults to "http://" if no other protocol is specified.
[edit] Optional Arguments
[edit] Info Text
Info text is text for the sign object. It will be displayed while the media is loading and after the media has finished. If omitted, the info text defaults to the contents of the object's description field (this is also the most common form of the sign command.) If specified, the into text must be enclosed in double quotes. Optionally, if the url or path includes spaces, the into text must be used to take the url or path, and the url option must be omitted.
[edit] Name
Name specifies the name of the same owner's object to place the media on.
[edit] Set
Set changes the attributes of an already playing media on the fly, without pausing or stopping the stream. Note, the resolution cannot be changed on the fly.
[edit] Pause
Pause is used to pause running media. Triggering a subsequent pause causes the media to continue playing where it was paused before.
- Note: Live-feeds cannot be paused. The streaming will continue, but the video rendering and the sound will be switched off / muted during the pause. Also note that the set or pause argument should be used before other parameters are defined.
[edit] Stop
Stop allows named objects can be used to stop running media.
[edit] Color
Color specifies the color to use for the sign text, and bcolor specifies the sign's background color. Both arguments are optional. The default color scheme is white text on a blue background. The colors can either be specified as one of many preset word values or as a "raw" hexadecimal value giving the red/green/blue component values (the same format as used for the BGCOLOR= HTML tag).
[edit] Res
Res specifies resolution used to the displayed video frames in pixel, if the media contains a video. Valid values are 64, 128, 256 and 512 pixels (default 256).
- Note that the proportions of the video (height and width) only depends on the sign's proportions and not on the used resolution.
[edit] FX
FX specifies a sound effect applied to the media. So far this list includes:
- 3D - causes the sound to pan according to your avatar's position.
[edit] Radius
Radius specifies the maximum distance in meters the sound can be heard. The default radius is 30 meters.
[edit] Radoff
Radoff specifies the maximum distance in meters the media stream will play. The default radoff is 30 meters. radoff cannot be smaller than radius. Outside the given radoff an ongoing media is stopped.
[edit] Vol
Vol specifies the relative volume of the played sound, in percent value. Valid values are in the range from 0 to 100, where 0% is silence (mute) and 100% is full volume. Default is 100%.
[edit] Loop
Loop specifies the count of loops to play the specified media file. Valid values are in the range from 1 to 2,147,483,647. Default is 1.
[edit] OSD
osd (on-screen display) specifies if a TV-like on-screen-display should be displayed on top of the video frames. Valid values are on/off, yes/ no, or true/false (default on)
[edit] EXT
ext forces the video to open an external window. If the media only contains audio, no external window is displayed. Valid values are on/off, yes/ no, or true/false (default off).
[edit] Nostop
nostop disables the mouse click or bump trigger to stop running media. Objects using the bump trigger always have this option set, to avoid subsequent on/off triggering of the media command. In conjunction with the activate trigger, this disables the toggle-switch-function, which is applied on media signs by default. When used with the create trigger the nostop argument has no effect.
[edit] Comments
The create trigger only works with the media command, if "Disable create url" is not checked in the world features settings. Other options that affect the media command are in the General tab and in the Downloads tab of the browser option settings.
[edit] Examples
[edit] 1
create media url=http://www.umpd.umd.edu/sirens/video/Windows/EWdownload.wmv
- This creates and plays the given media stream as soon the used sign object comes within your avatar's view range.
[edit] 2
create sign color=orange, name foo
On another object: activate media name=foo url=http://www.umpd.umd.edu/sirens/video/Windows/EWdownload.wmv
- This creates an empty sign object at first. As soon the activate command on the other object is triggered, the given media stream is displayed on the sign object named foo.
[edit] 3
create sign bcolor=red; activate media url=http://212.109.3.19:8000
- This creates an object that when clicked on, starts the media, and when clicked on the second time it switches it off again.
[edit] 4
create sign, name foo, solid off; bump media url=http://212.109.3.19:8000 name=foo On another object: create sign, name foo; bump media stop name=foo
- If your avatar collides with the first object, it will start the media. When colliding with the other object it stops the running media.
[edit] 5
create sign, name foo; activate media url=...
On another object: activate media pause name=foo
- This creates and plays the given media stream which can be paused by clicking the other object.
[edit] 6
create sign, name foo; activate media url=...
On other objects: activate media set vol=50 osd=off name=foo activate media set vol=100 osd=on name=foo
- This will change the parameters of an already playing media.
[edit] Important Note About Media Files
The purpose of this command is to allow you to customize your building with your own personal media and artwork. It should be treated exactly the same as the HTML tag; in other words, it is not appropriate to link to media streams and files on other people's web sites without their permission. This can cause their web servers to experience extra load and possibly cost the owners money. A good rule to follow is: when in doubt, you should only link to media files on your own website. Also, remember that many media files on the web are protected by copyrights. Linking to these media files without the owner's permission, whether on your web site or theirs, is illegal and could subject you to criminal prosecution.
|
|
|
|
|
Triggers: Create • Bump • Activate • Adone • Sdone • Enter Zone • Exit Zone
Commands: Animate • Astart • Astop • Camera • Color • Corona • Envi • Examine • Frame • Group • Light • Link • Lock • Matfx • Media • Midi • Move |
