LlGetPrimMediaParams
Looking for the current API? Open the llGetPrimMediaParams reference →
Wiki description
Get the media params for a particular face on an object, given the desired list of names.
Function notes
Returns an empty list if no media exists on the face.
Return value notes
Returns a list of values in the order requested.
Specification
PRIM_MEDIA_CONTROLS_STANDARD integer 0 m=3 s3=colspan="6" s1=id="PRIM_MEDIA_CONTROLS_STANDARD" c=Standard web navigation controls.
PRIM_MEDIA_CONTROLS_MINI integer 1 m=3 s3=colspan="6" s1=id="PRIM_MEDIA_CONTROLS_MINI" c=Mini web navigation controls; does not include an address bar.
PRIM_MEDIA_FIRST_CLICK_INTERACT integer 8 b=[ e= ] s=rowspan="1" s1=id="PRIM_MEDIA_FIRST_CLICK_INTERACT"
| Parameter | Return Values | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|
[ 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. | ||||||||
[ integer control ] | Gets the style of controls. Can be either PRIM_MEDIA_CONTROLS_STANDARD or PRIM_MEDIA_CONTROLS_MINI. | ||||||||
controls Flags | Description | ||||||||
[ string current_url ] | Gets the current url displayed on the chosen face. Changing this URL causes navigation. 1024 characters Max | ||||||||
[ string home_url ] | Gets the home url for the chosen face. 1024 characters max | ||||||||
[ integer boolean ] | Gets whether auto-looping is enabled. | ||||||||
[ integer boolean ] | Gets whether the media auto-plays when a Resident can view it. | ||||||||
[ integer boolean ] | Gets whether auto-scaling is enabled. Auto-scaling forces the media to the full size of the texture. | ||||||||
[ integer boolean ] | Gets whether clicking the media triggers auto-zoom and auto-focus on the media. | ||||||||
[ integer boolean ] | Gets what happens when someone click on a playing, but unfocused media face:
| ||||||||
[ integer width ] | Gets the width of the media in pixels. | ||||||||
[ integer height ] | Gets the height of the media in pixels. | ||||||||
[ integer boolean ] | Gets whether navigation is restricted to URLs in PRIM_MEDIA_WHITELIST. | ||||||||
[ 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. | ||||||||
[ integer perms ] | Gets the permissions mask that control who can interact with the object: | ||||||||
[ integer perms ] | Gets the permissions mask that control who can see the media control bar above the object: | ||||||||
Helper functions
list GetPrimMediaParams(integer face, list input)
{//Returns a list that can be fed to llSetLinkMedia or llSetPrimMediaParams
list output;
integer c = ~llGetListLength(input);
while((c = - ~c))
{
list flag = llList2List(input, c, c);
output += flag + llGetLinkMedia(LINK_THIS, face, flag);
}
if(output == input)
return [];
return output;
}See also: functions
History
- SVN:2816 r134947 Trunk
- SVC-4939
Shared wiki helpers
The original page also injects shared parameter notes, caveats or issue information through these helpers. Their conditional MediaWiki logic is not reproduced here; inspect the preserved helper source for additional material.
Original shared helper source (conditional wiki logic is not evaluated)
{{Issues|SVC-4939|[http://svn.secondlife.com/trac/linden/changeset/2816 SVN Changeset 2816 in Trunk] is immature|type=bug|dnc=*}}Original shared helper source (conditional wiki logic is not evaluated)
{{LSL Injection Test}}{{#if:
{{#vardefine:header|{{#var:header}}{{#if:{{{nc|}}}{{#pos:{{#var:moded}}|r}}||{{#switch:{{NAMESPACE}}|Template=|User=|[[Category:LSL Face{{#var:lang}}]][[Category:LSL Face{{#var:lang}}/{{#if:{{{return|}}}{{{returns|}}}|Get|Set}}]]}}}}}}
{{#vardefine:ALL_SIDES|{{LSL Const|ALL_SIDES|integer|-1|hex=0xFFFFFFFF}}}}
{{#vardefine:p_{{{1|none}}}_desc|{{LSLGC|Face{{#var:lang}}|face}} number{{#ifeq:{{{notall|}}}|*||<nowiki> </nowiki>or {{#var:ALL_SIDES}}}}}}
{{#vardefine:p_{{{1|none}}}_hover|face number{{#ifeq:{{{notall|}}}|*||<nowiki> </nowiki>or ALL_SIDES (-1)}}}}
{{#ifeq:{{{notall|}}}|*||{{#vardefine:facechoise|If {{LSLP|{{{1|none}}}}} is {{#var:ALL_SIDES}} then the {{#if:{{{2|}}}|{{{2|}}}|function}} {{#if:{{{get|}}}|{{{get|}}}|{{#if:{{{ALL_SIDES|}}}|{{{ALL_SIDES|}}}|works on all sides.}}}}}}}}
{{#vardefine:header_footnote|{{#var:header_footnote}}{{#if:{{{!footer|}}}||{{PBR}}
{{#var:facechoise}}{{PBR}}}}}}
{{#vardefine:caveats|{{#var:caveats}}{{#if:{{{!footer|}}}|
*{{#var:facechoise}}|}}{{#if:{{{return|}}}{{{returns|}}}|
*If {{LSLP|{{{1|none}}}}} indicates a face that does not exist the {{#if:{{{2|}}}|{{{2|}}}}} {{#if:{{{return|}}}|return is {{{return|}}}| returns {{{returns|}}}}}|
*The {{#if:{{{2|}}}|{{{2|}}}|function}} silently fails if its {{LSLP|{{{1|none}}}}} value indicates a face that does not exist.}}}}
}}<noinclude>
{| {{Prettytable}}
|-{{Hl2}}
! #var
! value
|-
{{VarPair|ALL_SIDES}}
|-
{{VarPair|p_{{{1|none}}}_desc}}
|-
{{VarPair|p_{{{1|none}}}_hover}}
|-
{{VarPair|facechoise}}
|-
{{VarPair|header_footnote}}
|-
{{VarPair|caveats}}
|}
</noinclude>Original wiki source
Some wiki templates and tables need their original context. View this article on the Second Life Wiki. Technical wording and examples are retained from the source; historical guidance may differ from current behavior.