player | |
Type | object |
Dictionary | LCS |
Library | LiveCode Script |
Syntax |
|
Summary | |
Introduced | 1.0 |
OS | mac, windows, linux |
Platforms | desktop, server |
Example |
|
Related | Keyword: templatePlayer, control, file Property: filename, currentTime, qtIdleRate Function: movie Glossary: property, stack file, movie, loaded into memory, object type Object: stack, player |
Description | Use the player object type to display a movie or sound from a separate file. Unlike an audio clip or video clip, a player does not contain the movie or sound data. Instead, you use the player's filename property to indicate the separate file that holds the movie or sound. This reduces the memory required by your stack, because the movie or sound data is only loaded into memory when it's being used, rather than being loaded into memory whenever the stack file is open. However, it also makes it possible for the movie or sound data to be misplaced during distribution, since the file is separate from your stack file. A player is contained in a card, group, or background. Players cannot contain other objects.
|
Tags | objects |
Type | Name | Summary | Syntax |
---|---|---|---|
command | start | Resumes playing a paused movie or sound. | start <player> |
- - - | stop | Stops a currently playing sound or movie. | stop [playing] {<player> | <videoClip> | <audioClip>} |
message | currentTimeChanged | currentTimeChanged <pNewTime> | |
- - - | deletePlayer | deletePlayer | |
- - - | dragDrop | Sent to the object where data was dropped when a drag and drop finishes. | dragDrop |
- - - | dragEnd | Sent to the object a drag and drop started from, when the data is dropped. | dragEnd |
- - - | dragEnter | Sent when the mouse pointer moves into an object during a drag and drop. | dragEnter |
- - - | dragLeave | Sent when the mouse pointer moves out of an object during a drag and drop. | dragLeave |
- - - | dragMove | Sent when the user moves the mouse during a drag and drop. | dragMove |
- - - | dragStart | Sent to a control when the user clicked on it and then started to drag the mouse pointer. | dragStart |
- - - | hotspotClicked | Sent to a player containing a QuickTime VR movie when the user clicks one of the movie's hot spots. | hotspotClicked <pHotspotID> |
- - - | mouseDoubleDown | Sent when the user double-clicks. | mouseDoubleDown <pButtonNumber> |
- - - | mouseDoubleUp | Sent when the mouse button is released at the end of a double-click. | mouseDoubleUp <pButtonNumber> |
- - - | mouseDown | Sent when the user presses the mouse button. | mouseDown <pButtonNumber> |
- - - | mouseEnter | Sent when the mouse pointer moves into an object. | mouseEnter |
- - - | mouseLeave | Sent when the mouse pointer moves out of an object. | mouseLeave |
- - - | mouseMove | Sent when the user moves the mouse. | mouseMove <pNewMouseH>, <pNewMouseV> |
- - - | mouseRelease | Sent when the user releases the mouse outside the control that was clicked. | mouseRelease <pButtonNumber> |
- - - | mouseStillDown | Sent periodically while the mouse button is being held down. | mouseStillDown <pButtonNumber> |
- - - | mouseUp | Sent when the user releases the mouse button. | mouseUp <pButtonNumber> |
- - - | mouseWithin | Sent periodically to an object while the mouse pointer is within its borders. | mouseWithin |
- - - | nameChanged | nameChanged <pOldName>, <pNewName> | |
- - - | newPlayer | Sent to a new player right after it's created. | newPlayer |
- - - | nodeChanged | Sent to a player containing a QuickTime VR movie when the current node is changed. | nodeChanged <pNewNodeID> |
- - - | playPaused | Sent to a player when the user pauses it. | playPaused |
- - - | playStarted | Sent to a player when it starts playing. | playStarted |
- - - | playStopped | Sent to a player when it stops playing. | playStopped |
- - - | qtDebugStr | Sent to a player containing a QuickTime movie when the movie performs a "DebugStr" action. | qtDebugStr <pString> |
- - - | resizeControl | Sent to a control right after the user resizes it. | resizeControl |
- - - | selectedObjectChanged | selectedObjectChanged | |
- - - | selectionChanged | selectionChanged | |
- - - | socketClosed | Sent when the remote system closes a socket. | socketClosed <pSocketID> |
- - - | socketError | Sent when an error occurs on a socket that causes the socket to close or to fail to open. | socketError <pSocketID>, <pErrorString> |
- - - | socketTimeout | Sent when an open socket, read from socket or write to socket command halts for the time specified by the socketTimeoutInterval property. | socketTimeout <pSocketID> |
property | altID | set the altID of <object> to <IDNumber> | |
- - - | audioPan | Specifies the proportion of audio panned from one stereo channel to the other. | set the audioPan of <player> to <positive/negative percentage> |
- - - | backgroundColor | Specifies an object's background color. | set the backgroundColor of <object> to {empty | <colorName> | <RGBColor>} set the backgroundColor [of <chunk>] [of <line>] of <field> to {empty| <colorName> | <RGBColor>} |
- - - | backgroundPattern | The backgroundPattern specifies the pattern used to draw an object's background. | set the backgroundPattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | backgroundPixel | Specifies which entry in the color table is used for an object's background color. | set the backgroundPixel of <object> to <colorNumber> |
- - - | behavior | Allows an object to inherit its script handlers from another object. | set the behavior of <object> to {<button> | <stack>} |
- - - | borderColor | Specifies the color of an object's border. | set the borderColor of <object> to {empty | <colorName> | <RGBColor>} set the borderColor of <line> of <field> to {empty | <colorName> | <RGBColor>} |
- - - | borderPattern | Specifies the pattern of an object's border. | set the borderPattern of <object> to {empty | <patternNumber> | <imageID>} |
- - - | borderPixel | Specifies which entry in the color table is used for the color of an object's border. | set the borderPixel of <object> to <colorNumber> |
- - - | bottom | Specifies how far an object's bottom edge is from the top of the window or screen. | set the bottom of <object> to <number> |
- - - | bottomColor | Specifies the color of a three-D object's lowered edge. | set the bottomColor of <object> to {empty | <colorName> | <RGBColor>} |
- - - | bottomLeft | Specifies the location of the specified object's lower left corner. | set the bottomLeft of <object> to <left>, <bottom> |
- - - | bottomPattern | Specifies the pattern of a three-D object's lowered edge. | set the bottomPattern of <object> to {empty | <patternNumber> | <imageID>} |
- - - | bottomPixel | Specifies which entry in the color table is used for the color of a three-D object's lowered edge. | set the bottomPixel of <object> to <colorNumber> |
- - - | bottomRight | Specifies the location of the specified object's lower right corner. | set the bottomRight of <object> to right,bottom |
- - - | callbacks | Specifies messages to be sent during playback of a movie. | set the callbacks of <player> to <messageList> |
- - - | colorOverlay | Specifies the color overlay to use for an object. | set the colorOverlay of object to <propertiesArray> set the colorOverlay[<propertyName>] of object to <propertyValue> |
- - - | colors | Specifies all the colors of an object, in shorthand form. | set the colors of <object> to <colorsList> |
- - - | constraints | Limits the pan, tilt, and zoom in a QuickTime VR movie. | get the constraints of <player> |
- - - | container | This property defines how the layout of a control behaves with respect to its owner. | set the container[propertyName] of object to propertyValue get the container[propertyName] of object |
- - - | container expanded | Expands the control so that it fills the available space. | set the container["type"] of object to "expanded" |
- - - | container flexible | Expands the control so that it fills the available space. | set the container["type"] of object to "expanded" |
- - - | currentNode | Specifies the current node in a QuickTime VR movie. | set the currentNode of <player> to <nodeID> |
- - - | currentTime | Specifies the elapsed time in a movie or sound. | set the currentTime of <player> to <number> |
- - - | cursorHover | Specifies the mouse cursor to be displayed when pointing over a control. | get the cursorHover of object set the cursorHover of object to {cursorName | imageID} |
- - - | customKeys | Lists the names of all the custom properties of an object. | set the customKeys of <object> to {<propertiesList> | empty} |
- - - | customProperties | Specifies all the custom properties of an object that are in the current customPropertySet, along with their settings. | set the customProperties of <object> to <propertiesArray> set the customProperties[<propertySet>] of <object> to <propertiesArray> |
- - - | customPropertySet | Specifies a set of custom properties applied to an object. | set the customPropertySet of object to {setName | empty} |
- - - | customPropertySets | Lists all the custom property sets that can apply to an object. | get the customPropertySets of <object> |
- - - | disabled | Specifies that an object is dimmed and does not respond to user action. | set the disabled of <object> to {true | false} |
- - - | dontUseQT | Disables the ability to use QuickTime. | set the dontUseQT [of player <player>] to {true | false} |
- - - | dropShadow | Specifies the drop shadow to use for an object. | set the dropShadow of object to <propertiesArray> set the dropShadow[<propertyName>] of object to <propertyValue> |
- - - | duration | Specifies the length of a sound or movie. | get the duration of <player> |
- - - | enabled | Specifies that an object is active and responds to user action. | set the enabled of <object> to {true | false} |
- - - | enabledTracks | Specifies which tracks in a QuickTime movie are available to be played. | set the enabledTracks of <player> to <tracksList> |
- - - | endTime | Specifies the end of the selected portion of a sound or movie. | set the endTime of <player> to <endPoint> |
- - - | filename | Specifies the file associated with a player or image. | set the filename of {<image> | <player>} to {<filePath> | <URL>} |
- - - | flex | The flex factor to use for the control. | get the flex of object set the flex of object to {<integer>} |
- - - | focusColor | Specifies the color of the outline around the active control or the field with the insertion point. | set the focusColor of <object> to {empty | <colorName> | <RGBColor>} |
- - - | focusPattern | Specifies the pattern used for an object's outline when it has the insertion point or is active focused. | set the focusPattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | focusPixel | Specifies which entry in the color table is used for the color of an object's outline when it has the insertion point or is active focused. | set the focusPixel of <object> to <colorNumber> |
- - - | foregroundColor | Specifies the color of object text and borders. | set the foregroundColor of <object> to {empty | <colorName> | <RGBColor>} set the foregroundColor of [<chunk> of] <field> to {empty| <colorName> | <RGBColor>} |
- - - | foregroundPattern | Specifies the pattern used for object text and borders. | set the foregroundPattern of <object> to {<patternNumber> | <imageID> | empty} set the foregroundPattern of [<chunk> of] <field> to {<patternNumber> | <imageID> | empty} |
- - - | foregroundPixel | Specifies which entry in the color table is used for an object's text and borders. | set the foregroundPixel of <object> to <colorNumber> |
- - - | formattedHeight | Reports the height needed by an object to display its full contents without scrolling. | get the formattedHeight of <object> get the formattedHeight of [<chunk> of] <field> |
- - - | formattedWidth | Reports the width needed by an object to display its full contents without scrolling. | get the formattedWidth of <object> get the formattedWidth of [<chunk> of] <field> |
- - - | height | Specifies the distance from an object's top edge to its bottom edge. | set the height of <object> to <numberOfPixels> |
- - - | hiliteColor | Specifies the color of the background when an object, or text in an object, is highlighted. | set the hiliteColor [of <object>] to {empty | <colorName> | <RGBColor>} |
- - - | hilitePattern | Specifies the fill pattern used for the background when an object, or text in an object, is highlighted. | set the hilitePattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | hilitePixel | Specifies which entry in the color table is used for the background color when an object, or text in an object, is highlighted. | set the hilitePixel of <object> to <colorNumber> |
- - - | hotspots | Reports a list of the clickable hot spots in a QuickTime VR movie. | get the hotspots of <player> |
- - - | ID | Reports the unique ID number assigned to an object. | set the ID of {image | stack} to <number> get the [{ long | abbreviated | short }] ID of <object> |
- - - | innerGlow | Specifies the inner glow to use for an object | set the innerGlow of object to <propertiesArray> set the innerGlow[<propertyName>] of object to <propertyValue> |
- - - | innerShadow | Specifies the inner shadow to use for an object. | set the innerShadow of object to <propertiesArray> set the innerShadow[<propertyName>] of object to <propertyValue> |
- - - | invisible | Specifies whether an object is hidden. | set the invisible of <object> to {true | false} get the [effective] invisible of <object> |
- - - | layer | Specifies the back-to-front order of objects on a card or the order of cards in a stack. | set the layer of <object> to {<layerNumber> | top | bottom} |
- - - | layerMode | Specifies whether an object is dynamic or static. | set the layerMode of <object> to <mode> get the [effective] layerMode of <object> |
- - - | layoutBreakpoints | Gets the list of layout breakpoints that the object has. | get the layoutBreakpoints of object |
- - - | layoutMargins | Sets the margin for all four sides of a control. | get the layoutMargins of object set the layoutMargins of object to {pixels | horizontal, vertical |left, top, right, bottom} |
- - - | left | Specifies how far an object's left edge is from the left edge of the window or screen. | set the left of <object> to <numberOfPixels> |
- - - | leftBalance | Specifies the volume of the left stereo channel output of a player control. | set the leftBalance of <player> to <percentage> |
- - - | loadedTime | Specifies the time of a sound/movie, up to which the sound/movie can be played. | get the loadedTime of player "myPlayer" |
- - - | location | Specifies where an object is. | set the location of <object> to <point> |
- - - | looping | Specifies whether a movie or sound stops at the end, or restarts from the beginning. | set the looping of <player> to {true | false} |
- - - | mediaTypes | Specifies one or more types of media used in a movie. | get the mediaTypes of <player> |
- - - | mirrored | Specifies whether a player displays the video frames in "mirrored" mode. | set the mirrored of <player> to {true | false} |
- - - | movieControllerID | Reports a pointer to a movie's controller. | get the movieControllerID of <player> |
- - - | name | Specifies the name of an object. | set the [{ long | abbreviated | short }] name of <object> to <string> get the name |
- - - | nodes | Reports a list of the nodes in a QuickTime VR movie. | get the nodes of <player> |
- - - | number | Specifies an object's position within a file, a card's position within a stack, or a control's layer on a card. | set the number of <card> to <number> get the number of <object> |
- - - | order | The order that has a control within its owner. | get the order of object set the order of object to {<integer>} |
- - - | outerGlow | Specifies the outer glow to use for an object. | set the outerglow of object to <propertiesArray> set the outerglow[<propertyName>] of object to <propertyValue> |
- - - | owner | Reports which object is next in the object hierarchy. | get the [{ long | abbreviated | short }] owner of <object> |
- - - | pan | Specifies the current horizontal view angle of a QuickTime VR movie. | set the pan of <player> to <degrees> |
- - - | patterns | Specifies all the patterns of an object, in shorthand form. | set the patterns of <object> to <patternsList> |
- - - | paused | Specifies whether a sound or movie is paused. | set the paused of <player> to {true | false} |
- - - | playRate | Specifies how fast a player plays a movie. | set the playRate of <player> to <rate> |
- - - | playSelection | Specifies whether a player plays back its entire movie or sound, or only the selected portion. | set the playSelection of <player> to {true | false} |
- - - | position | Sets how the object is positioned within its owner. | get the position[propertyName] of object set the position[propertyName] of object to propertyValue |
- - - | position align | Aligns the control within its owner. | set the position["type"] of object to "align" |
- - - | position center | Centers the object with respect to its owner. | set the position["type"] of object to "center" |
- - - | position fixed | Sets the position of one or more sides of a control with respect to its owner. | set the position["type"] of object to "fixed" |
- - - | properties | Specifies some of an object's properties and their current values. | set the properties of <object> to <propertiesArray> |
- - - | rectangle | Specifies the area within which an object is drawn. | set the rectangle of <object> to <left>, <top>, <right>, <bottom> get the [effective] rectangle of <object> |
- - - | right | Specifies how far an object's right edge is from the left edge of the window or screen. | set the right of <object> to <pixels> |
- - - | rightBalance | Specifies the volume of the right stereo channel output of a player control. | set the rightBalance of <player> to <percentage> |
- - - | script | set the script of <object> to <string> | |
- - - | selected | set the selected of <object> to {true | false} | |
- - - | shadowColor | Specifies the color of an object's drop shadow or the background of a scrollbar. | set the shadowColor of <object> to {empty | <colorName> | <RGBColor>} |
- - - | shadowOffset | Specifies the size and direction of an object's drop shadow. | set the shadowOffset of <object> to <pixels> |
- - - | shadowPattern | Specifies the pattern of an object's drop shadow. | set the shadowPattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | shadowPixel | Specifies which entry in the color table is used for the color of an object's drop shadow or the background of a scrollbar. | set the shadowPixel of <object> to <colorNumber> |
- - - | showBadge | Specifies whether a player's badge icon is visible. | set the showBadge of <player> to {true | false} |
- - - | showBorder | Specifies whether an outline is drawn around an object. | set the showBorder of <object> to {true | false} |
- - - | showController | Specifies whether a player's controller bar is visible. | set the showController of <player> to {true | false} |
- - - | showFocusBorder | Displays a border around the active control. | set the showFocusBorder of <control> to {true | false} |
- - - | showSelection | Specifies whether the user can select a portion of the movie or sound in a player. | set the showSelection of <player> to {true | false} |
- - - | startTime | Specifies the beginning of the selected portion of a sound or movie. | set the startTime of <player> to <startPoint> |
- - - | status | Specifies the current status of a player object | put the status of player "myPlayer" into tStatus |
- - - | textFont | set the textFont of <object> to <fontName> [, <language>] set the textFont of [<chunk> of] <field> to <fontName> [, <language>] | |
- - - | textSize | set the textSize of <object> to <pointSize> set the textSize of [<chunk> of] <field> to <pointSize> | |
- - - | textStyle | Specifies the style or styles applied to text in an object. | set the textStyle of <object> to {empty | plain | <stylesList>} set the textStyle of [<chunk> of] <field> to {empty | plain | <stylesList>} set the textStyle[<style>] of object to {true | false} |
- - - | threeD | Specifies whether an object appears to stick out of or recede into the screen. | set the threeD of <object> to {true | false} |
- - - | tilt | Specifies the current vertical view angle of a QuickTime VR movie. | set the tilt of <player> to <degrees> |
- - - | timeScale | Reports the number of intervals per second of a movie or sound. | get the timeScale of <player> |
- - - | top | Specifies how far an object's top edge is from the top of the window or screen. | set the top of <object> to <numberOfPixels> |
- - - | topColor | Specifies the color of a three-D object's raised edge. | set the topColor of <object> to {empty | <colorName> | <RGBColor>} |
- - - | topLeft | Specifies the location of the specified object's upper left corner. | set the topLeft of <object> to left,top |
- - - | topPattern | Specifies the pattern used to draw a three-D object's raised edge. | set the topPattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | topPixel | Specifies which entry in the color table is used for the color of a three-D object's raised edge. | set the topPixel of <object> to <colorNumber> |
- - - | topRight | Specifies the location of the specified object's upper right corner. | set the topRight of <object> to <right>, <top> |
- - - | trackCount | Specifies the number of separate tracks in a QuickTime movie. | get the trackCount of <player> |
- - - | tracks | Lists all the tracks in a QuickTime movie. | get the tracks of <player> |
- - - | unicodeTooltip | Specifies the explanatory text (UTF-16 string) that pops up in a small box when the user points to an object. | set the unicodeTooltip of object to <unicodeString> |
- - - | visible | Specifies whether an object can be seen or is hidden. | set the [effective] visible of <object> to {true | false} |
- - - | width | The width of an object is the distance from its left edge to its right edge. | set the width of <object> to <numberOfPixels> |
- - - | zoom | Specifies the field of view of a QuickTime VR movie. | set the zoom of <player> to <degrees> |