Chapter 6 Wrapped Class Reference
Section 6.1.3, "Attribute Manager - Abstract" page 118
on Present
Presents all existing presentations for a media element using the current settings for each individual presentation request of the element. The entire element is presented. Activities triggered: Depends on the actual element's Present activities.on PresentId: handle presentationID
Presents the element's specified presentation request. Activities triggered: Depends on the actual element's Present activities.on Dismiss
Dismisses all presentation requests for an element. A dismissed presentation is not removed nor is the loaded data destroyed. An element that is dismissed may be thought of as being off-stage ready to be presented again. A visual element's Dismiss method hides the element. Activities triggered: Depends on the actual element's activities.on DismissId: handle presentationID
Dismisses the element's specified presentation request. Activities triggered: Depends on the actual element's activities.on Remove
Removes all presentations of an element, which can not be presented again without creating new presentations. Dismiss is called on the element's presentations before they are removed. Activities triggered: Depends on the actual element's activities.on RemoveId: handle presentationID
Removes the element's specified presentation request. Activities triggered: Depends on the actual element's activities.
| Attribute | Type | Description | Access |
|---|---|---|---|
| name | string | a user or application defined element name | CSG |
| Activity | Keys | Description |
|---|---|---|
| DataReady | none | media data available |
| Present | none | element is presented |
| Dismiss | none | element is dismissed |
| Destroyed | none | element is destroyed |
Section 6.1.3, "Attribute Manager - Abstract" page 118
Registers and automatically shows all existing presentations of a media element.on PresentID: handle presentationID
Present registers and automatically shows the specified presentation.on PresentOn: handle hVisual return handle presentationID
on PresentAt: handle hVisual, integer x, integer y return handle presentationID
on PresentClipped: handle hVisual, integer x, integer y, integer clipW, integer clipH,
integer offsetX, integer offsetY return handle presentationID
on Register
Registers all existing presentations of the media element but does not show the presentations.on RegisterID: handle presentationID
Registers the specified presentation but does not show the presentation of specified handle.on RegisterOn: handle hVisual return handle presentationID
on RegisterAt: handle hVisual, integer x, integer y return handle presentationID
on RegisterClipped: handle hVisual, integer x, integer y, integer clipW, integer clipH,
integer offsetX, integer offsetY return handle presentationID
on Show
Maps all of the elements existing presentations onto their specified XFvisuals.on ShowID: handle presentationID
Maps the presentation onto the specified XFvisual at the location specified.on Hide
Hides all presentations of the image, if clearMode is TRUE, the areas are cleared.on HideID: handle presentationID
Unmaps the specified presentation, the presentationID is not removed, and the media element is not unloaded. Show methods may be called after a Hide method.on Dismiss
The element stops presenting all presentations of itself, any screen updates are stopped and, if the element is temporal, no new frames are presented. If clearMode is TRUE the images are cleared. The presentationIDs are still valid.on DismissID: handle presentationID
Screen updates are stopped and, if the element is temporal, no new frames are presented. If clearMode is TRUE the image is cleared. The presentationID is still valid.
| Attribute | Type | Description | Access |
|---|---|---|---|
| width | integer | width of image | G |
| height | integer | height of image | G |
| clearMode | boolean | clears presentation from the screen automatically if presentation is hidden or removed, default TRUE | CSG |
| Activity | Keys | Description |
|---|---|---|
| DataReady | none | After a load is complete |
Section 6.1.3, "Attribute Manager - Abstract" page 118
Note that some temporal methods behavior depends on the type of the specification provided:
If either side of the interval is open, use the sequence's start or end position.
on Present
"Play"s all current presentations from start to end using the current settings. Activities triggered: Play and RateChange.on PresentId: handle presentationID
on Play: any specification (only on UNIX)
Behavior of this method is controlled by the type of specification provided (see note above). Activities triggered: Play and RateChange, PositionChange if seek to new location.on PlayId: handle presentationID, any specification
on PlayAll
on PlayAllId: handle presentationID (only on UNIX)
Play the entire media element at the default or requested rate. Activities triggered: Play and RateChange, PositionChange if seek to new location.on PlayInterval: interval range
on PlayIntervalId: handle presentationID, interval range (only on UNIX)
Play the range specified within the interval, if either side of the interval is open use the sequence's start or end position. Interval values may be either timestamps or positions and may be mixed. Please note many media types do not support playing backwards. Activities triggered: Play and RateChange, PositionChange if seek to new location.on PlaySeq: integer start, integer end
on PlaySeqId: handle presentationID, integer start, integer end (only on UNIX)
Play the sequence of positions starting at "start" and stopping at "end" at the default or requested rate. Please note may media types do not support playing backwards. Activities triggered: Play and RateChange, PositionChange if seek to new location.on PlayUntil: value val (only on UNIX)
on PlayUntil: value val return handle presentationID (only on UNIX)
on Pause
on PauseId: handle presentationID (only on UNIX)
If the element is being presented, it pauses. A paused media element may be resumed. Activities triggered: RateChange.on Resume
on ResumeId: handle presentationID (only on UNIX)
If the element is paused, presentation continues from where it was paused. Activities triggered: RateChange.on Stop
on StopId: handle presentationID
If the element is being presented or paused it is stopped, a stopped element may not beon Seek: any location, boolean present
resumed. The element is not unloaded and may receive new presentation or play commands,
but by default it starts at the beginning again. Activities triggered: Stop and RateChange.
on SeekId: handle presentationID, any location, boolean present (only on UNIX)
Seeks to location specified by the value location. Location is relative to the beginning of the sequence. Location may be either an integer, which is used as a media specific frame or position, or a time value, which is used as the number of milliseconds into the sequence. If present is TRUE and element is a visual type present the frame. Activities triggered: PositionChangeon GoStart
on GoStartId: handle presentationID (only on UNIX)
Seeks to start of sequence. Visual elements display first frame. Triggered: PositionChangeon GoEnd
on GoEndId: handle presentationID (only on UNIX)
Seeks to the end of sequence. Visual elements display last frame. Triggered: PositionChangeon Jump: any location, boolean present
on JumpId: handle presentationID, any location, boolean present (only on UNIX)
Jumps to location (an offset of the number of images from the current position). If present is TRUE and the element is a visual type, present the frame. Triggered: PositionChangeon GoPPS: integer positionsPerSecond
on GoPPSId: handle presentationID, integer positionsPerSecond (only on UNIX)
Presents the media at the specified positions per second. Activities triggered: RateChangeon GoRate: real rate
on GoRateId: handle presentationID, real rate (only on UNIX)
Attempts to present the media at the specified rate based on default PPS = 1.0. Activities triggered: RateChangeon ToPosition: time duration returns integer
Does not affect the media element but converts a time value into an element specific native position, or number of positions. Positions are calculated using the default PPS.on ToTime: integer position returns time
Does not affect the media element but converts an integer position, into an element specific timestamp or duration. Time is calculated using the default PPS.
Section 6.1.3, "Attribute Manager - Abstract" page 118
on PresentId: handle presentationId
Presents the entire sound element using the current output gain and device. Activities triggered: Play and RateChange.on PresentSequence: integer start, integer end, real volume return handle presentationID
Creates, registers ad presents an audio presentation request. The start position, end position and volume are set to the specified lvalues. The presentationID is returned.on PresentVolume: real volume return handle presentationID (only on UNIX)
Creates, registers and presents an audio presentation request. The volume is set to the specified level, the start and end positions default to beginning and end of data, and the presentationID is returned.on RegisterSequence: integer start, integer end, real volume return handle presentationID
Creates and registers an audio presentation request. The start position, end position and volume are set to the specified lvalues. The presentationID is returned.on RegisterVolume: real volume return handle presentationID (only on UNIX)
Creates and registers an audio presentation request. The volume is set to the specified level, the start and end positions default to beginning and end of data, and the presentationID is returned.on Seek: any location, boolean present
Seeks to the location specified by the value location, the specified position is relative to the beginning of the sequence. Location may be either a integer which is used as a media specific frame or position, or a UTtime which is used as the number of milliseconds into the sequence. Note: An audio position is not presented upon Seek since a single sample is not useful. Activities triggered: PositionChange.
| Activity | Keys | Description |
|---|---|---|
| AudioChanged | none | gain for any channel changed |
| AudioAChanged | none | gain for channel A changed (left) |
| AudioBChanged | none | gain for channel B changed (right) |
{"MAfile","pathname"} The short form must be a list of two strings.
Section 6.1.3, "Attribute Manager - Abstract" page 118
The "mediaDescription" is a list which matches the format specified above. A media element is created and a handle to it is returned.on LoadColorNames: string filePath
Loads colors defined within the file as the color database colors. Deletes all colors currently in the default color database. See /usr/lib/rgb.txt for file format.on AppendColorNames: string filePath
Appends colors defined in the file to the color database. All colors currently in the default color database remain. Multiple entries may have the same name and or color values, searches of the database usually return the first 'match' found. See /usr/lib/rgb.txt for file format.
Default constructor. Name is 'none', color is all zeros ( Black).
on createName: string colorname
Creates a color name. If the default color database contains the name of the RGB, values are set to match the name's values, else they are set to zero ( Black ).on createRGB: integer green, integer red, integer blue
Creates a color of the specified RGB settings. If the default color database contains a color with matching RGB values, name is set to match the found color name, else is set to 'none'.on createHVS: real hue, real value, real saturation
Creates a color of the specified HVS settings. If the default color database contains a color with matching RGB values name is set to match the found color name, else is set to 'none'.on createNamedRGB: string colorname, integer green, integer red, integer blue
Creates a color of the specified name with the specified RGB settings. Color database is not checked.on createNamedHVS: string colorname, real hue, real value, real saturation
Creates a color of the specified name with the specified HVS settings.
| Attribute | Type | Description | Access |
|---|---|---|---|
| color | handle | A representation of the packed RGB values in a 32 bit integer | CSG |
| red | integer | This sets the level of red in a RGB color specification. | CSG |
| green | integer | This sets the level of green in a RGB color specification. | CSG |
| blue | integer | This sets the level of blue in a RGB color specification. | CSG |
| hue | real | This sets the hue in an HVS color specification. Range is 0.0 to 360.0 | CSG |
| value | real | This sets the brightness in an HVS color specification. Range is 0.0 to 100.0 | CSG |
| saturation | real | This sets the saturation in an HVS color specification. Range is 0.0 to 100.0 | CSG |
| name | string | Specifies a user or applicaiton defined color. | CSG |
Section 6.3.2, "MMvisual - Abstract" page 174
Default constructor. Requires access descriptor to image. Description should be of the form {<type>, {'MAfile, <filename>}}, where <type> is the type of the image (one of: 'MEgif, 'MEjpeg, 'MEpbm, 'MEphotoCD, 'MEtiff, 'MExbm, or 'MEimage to auto-detect), and <filename> is the name of the image file. An example of a constructor follows:on List: returns list
'Construct, { 'MEimage, { 'MAfile, "bigcat.gif"}}
Returns an object descriptor list, which may be used to re-create the object. The returned list is formatted to be used as the list argument to the MMbroker to MakeElement or to the class's Construct method which has a list argument.on Load: return integer
Loads the image into memory. Returns zero on success.on Unload: return boolean
Unloads any media data, closes the elements data file, stops the refreshing of the image and returns TRUE when complete. The media element is not deleted or destroyed so it is possible to redisplay the image with another present command. Note: all existing presentations are removed and made invalid. If you plan on hiding and showing the image this is not the method to call since the media data will have to be reloaded and a new presentation requested.on SetSize: integer width, integer height
Set the image to a new size.on Zoom: real scaleX, real scaleY
Zoom changes the size of all presentations created from this element, currently the image must be Zoomed before the image is presented. To present the same image with different scale factors, another instance of the MMimage is required. This will change in the future. If a clip region is not specified, the presented image is the size of the image after the Zoom.
| Attribute | Type | Description | Access |
|---|---|---|---|
| width | integer | width of image | G |
| height | integer | height of image | G |
| clearMode | boolean | clear on remove sink automatically, default false | CSG |
| Activity | Keys | Description |
|---|---|---|
| DataReady | none | after a load is complete |
Section 6.3.3, "MMtemporal - Abstract" page 176
Section 6.3.4, "MMaudioControl - Abstract" page 180
Default constructor; Description list should follow this format where <filename> is the name of the data file:on List: returns list
'Construct {'MEdigitalAudio, {'MAfile, 'filename}, {'arguments,{'gainA, 1.0}, {'gainB,0.0}}}
Returns an object descriptor list, which may be used to re-create the object. The returned list is formatted to be used as the list argument to the MMbroker to MakeElement or to the class's Construct method which has a list argument.on Load: return boolean
Loads the media data and confirms that audio services are connected. Activities triggered: DataReady.
Section 6.3.2, "MMvisual - Abstract" page 174
Section 6.3.3, "MMtemporal - Abstract" page 176
Section 6.3.4, "MMaudioControl - Abstract" page 180
Section 6.3.7, "MMimage" page 184
Section 6.3.8, "MMdigitalAudio" page 187
Initializes the audio stream.The audio PresentationId defines the audio stream to be recorded. The frequency is set. Returns an audio presentationID.on Process: handle hAudioPresID
Begins the recording process. Audio stream, duration and frequency are set within the presentation ID.on MakeFreqImage: handle hAudioPresID, integer width, integer height return handle
If the Process method has not been called it is started, after Process complets the recorded audio is converted into an image.Sound represented as a frequency graphic of given width and height. Handle returned is a MMimage.on MakeWaveImage: handle hAudioPresID, integer width, integer height return handle
If the Process method has not been called it is started, after Process complets the recorded audio is converted into an image. Sound represented as an amplitude wave of given width and height. Handle returned is an MMimage.on BlankProcess: handle hAudioPresID
Calls Process, but no image is produced.
| Attribute | Type | Description | Access |
|---|---|---|---|
| numberToSum | integer | default value | CSG |
| xJump | integer | sets the height of wave to be represented visually | CSG |
| freqJump | integer | sets the width of wave to be represented visually | CSG |
| minConsecutive | integer | sets the minimum consecutive points to be represented as a smooth curve | CSG |
| tooClose | integer | x value of height too small to be registered visually | CSG |
| yTooClose | integer | y value of width too small to be registered visually | CSG |
| minVol | integer | the minimum volume of sound to be registered visually | CSG |
Section 6.3.2, "MMvisual - Abstract" page 174
Section 6.3.3, "MMtemporal - Abstract" page 176
Section 6.3.4, "MMaudioControl - Abstract" page 180
Section 6.3.7, "MMimage" page 184
Section 6.3.8, "MMdigitalAudio" page 187
Default constructor. Requires access descriptor to image. Description should be of the form {<type>, {'MAfile, <filename>}}, where <type> is the type of the movie (one of: 'MEmpeg, 'MEavi, 'MEjpeg, 'MEfli, 'MEqt or 'MEmovie to auto-detect), and <filename> is the name of the image file. The following is an example of a construction for an MMmovie:on List: return list
'Construct, {'MEanim, {'arguments, {'gain, 0.3}}, {'MAfile, "claylzrd.avi"}}
Returns an object descriptor list, which may be used to re-create the object. The returned list is formatted to be used as the list argument to the MMbroker to MakeElement or to the class's Construct method which has a list argument.on Load: return integer
Loads the image into memory; returns zero on success.
The media class model expects that devices are managed by the media elements requesting their services. The player was made available to ADL mainly for testing and to allow run time specification of configuration information via the asset manager.
Note: The video disc player does not display the video, but only makes the analog signal available. The media element MEvideo provides an interface to show a 'live video stream' the
MEvideo class is represented in the ADL as a type of MMimage since there is no control of the video stream but only its placement and mapping.
Section 6.3.2, "MMvisual - Abstract" page 174
Section 6.3.4, "MMaudioControl - Abstract" page 180
Constructs the MMvidDiscPlayer object from an object descriptor list. For the video player, this requires device type information, serial line specification and configuration, and an optional video disc specification.on List: returns list
Returns an video disc object descriptor list, which may be used to re-create the object. The returned list is formatted to be used as the list argument to the MMbroker to MakeElement or to the class's Construct method which has a list argument. The following is an example:on Load
list objectList = {'MEvidDiscSeq, {'arguments,{'start, 12345},{'end, 14500},{'gainA,1.0},{'gainB,0.0}}, {'MAvidDiscVol, {'arguments,{'volName,'Louvre_2}}} };
If a disc is in the drive, it spins up the drive and positions the head to frame 1.on Unload
Spins down the drive and, if supported, ejects the video disc.on Mount
Unmounts any current disc, if it is not busy, loads the current disc, and updates theon Unmount
videoDiscAgents volume list.
Removes the disc from the videoDiscAgent's volume table.on PlaySeq: integer position1, integer position2, real rate
Plays the disc from position1 to position2, at a frame rate calculated based on the default rate (30 PPS). Depending on the state of video, audio1 & audio2 each analog signal may be output.on Pause: time duration
Stops the disc and ignores duration.on Scan: integer speed
on Seek: integer offset, integer relativeTo
on Step: integer size
on Stop
| Attribute | Type | Description | Access |
|---|---|---|---|
| position | any | Set: integer, real or UTtime Get: integer | SG |
| PPS | integer | current Positions per Second, native media frame | SG |
| rate | real | SG | |
| video | boolean | video output enabled | CSG |
| audio1 | boolean | audio 1 output on/off | CSG |
| audio2 | boolean | audio 2 output on/off | CSG |
| index | boolean | frame index displayed on video | CSG |
Default constructor. Description is of the form {'MEhtml, {'MAfile, <filename>}} or {'MEhtml, {'URL, <url>}}, where <filename> is the name of the HTML file and <url> is the URL address of the HTML document.upon ConstructFromString: string text (only on UNIX)
Constructs an HTML object using the given text.upon ConstructFromStream: handle hStream (only on UNIX)
Constructs anon Load: return integerHTMLobject using the data extracted from hStream. As of the current release, hStream must be a handle to an instance of an IOwebStream subclass.
Loads the HTML document into memory; returns zero on success.on Unload: return boolean
Unloads the HTML document from memory; returns TRUE on success.on AddSink: handle hSink
Adds a sink on which the HTML document should be displayed; hSink should be a handle to an XFhtml or a subclass thereof.on RemoveSink: handle hSink
Stops displaying the HTML document on a sink.on Show
Displays the HTML document on whichever sinks have been added using AddSink.on Hide
Stops displaying the HTML document on all sinks.on GoToAnchor: string anchor_name return boolean
Displays the part of the HTML document referenced by anchor_name at the top of the HTML display surface; returns TRUE on success.on GetHTMLSrc: return string
Returns the HTML document as an HTML formatted string. Please note that the HTML document must be loaded before this method is called, otherwise an empty string is returned.on GetURL: return string
Returns the URL address of this HTML document. If this HTML document contains a BASE tag with an HREF attribute value, this method returns the URL contained in the BASE tag.on GetTitle: return string
Returns the title for this HTML document; if there is no title, this method returns an empty string.
Generated with Harlequin WebMaker