LlGetPrimMediaParams
From Second Life Wiki
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Contents |
Summary
Function: list llGetPrimMediaParams( integer face, list params );| 351 | Function ID |
| 1.0 | Forced Delay |
| 10.0 | Energy |
Get the media params for a particular face on an object, given the desired list of names.
Returns a list of values in the order requested.
| • integer | face | – | face number | |
| • list | params | – | a set of name (in no particular order) |
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.
- If face indicates a face that does not exist the return is an empty list.
Deep Notes
History
All Issues
~ Search JIRA for related Issues| | | SVC-4939 | [A, C] | SVN Changeset 2816 in Trunk is immature |
This article wasn't helpful for you? Maybe the related article at the LSL Wiki is able to bring enlightenment.

