llGetPrimMediaParams

From Second Life Wiki
Revision as of 16:06, 19 October 2009 by Strife Onizuka (talk | contribs)
Jump to navigation Jump to search
Emblem-important-red.png Pre-release Documentation Warning!

This function is not available yet. This documentation was written prior to its final release so it may not match the final implementation.It is slated for release in Server 1.33.0 and Client 1.24.4.

Summary

Function: integer llGetPrimMediaParams( integer face, list params );

Get the media params for a particular face on an object, given the desired list of names.
Returns an integer of values in the order requested.

• integer face – face number or ALL_SIDES
• list params – a set of name (in no particular order)

If face is ALL_SIDES then the function works on all sides. Returns an empty list if no media exists on the face.

Parameter Return Values Description
[ PRIM_MEDIA_ALT_IMAGE_ENABLE ] 0 [ integer boolean ] Gets the default image state (the image that the user sees before a piece of media is active) for the chosen face. The default image is specified by Second Life's server for that media type.

Note: This flag is not currently implemented.

[ PRIM_MEDIA_CONTROLS ] 1 [ integer control ] Gets the style of controls. Can be either PRIM_MEDIA_CONTROLS_STANDARD or PRIM_MEDIA_CONTROLS_MINI.
controls Flags Description
PRIM_MEDIA_CONTROLS_STANDARD 0 Standard web navigation controls.
PRIM_MEDIA_CONTROLS_MINI 1 Mini web navigation controls; does not include an address bar.
[ PRIM_MEDIA_CURRENT_URL ] 2 [ string current_url ] Gets the current url displayed on the chosen face. Changing this URL causes navigation. 1024 characters Max
[ PRIM_MEDIA_HOME_URL ] 3 [ string home_url ] Gets the home url for the chosen face. 1024 characters max
[ PRIM_MEDIA_AUTO_LOOP ] 4 [ integer boolean ] Gets whether auto-looping is enabled.
[ PRIM_MEDIA_AUTO_PLAY ] 5 [ integer boolean ] Gets whether the media auto-plays when a Resident can view it.
[ PRIM_MEDIA_AUTO_SCALE ] 6 [ integer boolean ] Gets whether auto-scaling is enabled. Auto-scaling forces the media to the full size of the texture.
[ PRIM_MEDIA_AUTO_ZOOM ] 7 [ integer boolean ] Gets whether clicking the media triggers auto-zoom and auto-focus on the media.
[ PRIM_MEDIA_FIRST_CLICK_INTERACT ] 8 [ integer boolean ] Gets whether the first click interaction is enabled.

Note: This flag appears not to work.

[ PRIM_MEDIA_WIDTH_PIXELS ] 9 [ integer width ] Gets the width of the media in pixels.
[ PRIM_MEDIA_HEIGHT_PIXELS ] 10 [ integer height ] Gets the height of the media in pixels.
[ PRIM_MEDIA_WHITELIST_ENABLE ] 11 [ integer boolean ] Gets whether navigation is restricted to URLs in PRIM_MEDIA_WHITELIST.
[ PRIM_MEDIA_WHITELIST ] 12 [ string CSV ] Gets the whitelist as a string of escaped, comma-separated URLs. This string can hold up to 64 URLs or 1024 characters, whichever comes first.
[ PRIM_MEDIA_PERMS_INTERACT ] 13 [ integer perms ] Gets the permissions mask that control who can interact with the object:
[ PRIM_MEDIA_PERMS_CONTROL ] 14 [ integer perms ] Gets the permissions mask that control who can see the media control bar above the object:

Caveats

  • This function causes the script to sleep for 1.0 seconds.
  • The function silently fails if its face value indicates a face that does not exist.
All Issues ~ Search JIRA for related Bugs

Examples

See Also

Functions

•  llSetPrimMediaParams
•  llClearPrimMedia

Deep Notes

History

Search JIRA for related Issues

Signature

function integer llGetPrimMediaParams( integer face, list params );
integer PRIM_MEDIA_ALT_IMAGE_ENABLE = 0;
integer PRIM_MEDIA_CONTROLS = 1;
integer PRIM_MEDIA_CURRENT_URL = 2;
integer PRIM_MEDIA_HOME_URL = 3;
integer PRIM_MEDIA_AUTO_LOOP = 4;
integer PRIM_MEDIA_AUTO_PLAY = 5;
integer PRIM_MEDIA_AUTO_SCALE = 6;
integer PRIM_MEDIA_AUTO_ZOOM = 7;
integer PRIM_MEDIA_FIRST_CLICK_INTERACT = 8;
integer PRIM_MEDIA_WIDTH_PIXELS = 9;
integer PRIM_MEDIA_HEIGHT_PIXELS = 10;
integer PRIM_MEDIA_WHITELIST_ENABLE = 11;
integer PRIM_MEDIA_WHITELIST = 12;
integer PRIM_MEDIA_PERMS_INTERACT = 13;
integer PRIM_MEDIA_PERM_OWNER;
integer PRIM_MEDIA_PERM_GROUP;
integer PRIM_MEDIA_PERM_ANYONE;
integer PRIM_MEDIA_PERMS_CONTROL = 14;

integer PRIM_MEDIA_CONTROLS_STANDARD = 0;//Standard web navigation controls.
integer PRIM_MEDIA_CONTROLS_MINI = 1;//Mini web navigation controls; does not include an address bar.
Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlGetPrimMediaParams&oldid=606273"