Detailed Description

An object which holds and retrieves different types of audio such as for synthesis or various formats (mp3, ogg etc).

Inheritance diagram for PowerUI.AudioPackage:
PowerSlide.ITimingLeader PowerUI.ContentPackage Dom.EventTarget Dom.IEventTarget

Public Member Functions

 AudioPackage (string src)
 Creates a new package for the named file to get. The path must be absolute. You must then call PowerUI.AudioPackage.send to perform the request. More...
 
 AudioPackage (string src, Location relativeTo)
 Creates a new package for the named file to get. You must then call PowerUI.AudioPackage.send to perform the request. More...
 
 AudioPackage (AudioFormat contents)
 Creates a package for the given already loaded contents. More...
 
 AudioPackage (AudioClip clip)
 Creates an audio package containing the given clip. More...
 
 AudioPackage (string src, Location relativeTo, AudioClip clip)
 Creates an audio package containing the given clip. More...
 
void send ()
 Sends the request off. Callbacks such as onreadystatechange will be triggered. More...
 
void AssignClip (AudioClip clip)
 Assign the given clip to this package. More...
 
void GotClip (AudioClip clip)
 Assigns the given clip to this package, setting it as a 200 OK. More...
 
void Start (Dom.Node context)
 Called when this audio should now begin. More...
 
void Stop ()
 Called when this audio is no longer being displayed. More...
 
float GetCurrentTime ()
 The current time in seconds. More...
 
float GetDuration ()
 The clip length in seconds. Returns -1 if it's unknown. More...
 
- Public Member Functions inherited from PowerUI.ContentPackage
void setRequestBody (Json.JSObject toPost)
 Sets the PostData from the given JSON object. Changes the content type too. More...
 
void setRequestBody (string toPost)
 Sets the PostData from the given UTF8 string. More...
 
void abort ()
 Aborts this request. More...
 
void AttachForm (UnityEngine.WWWForm form)
 Adds the given form to this request. Note that if you wish to also use custom headers with a form, call this first. Then, add to the Headers property. More...
 
void TimedOut ()
 The request has timed out. More...
 
void NotModified (CachedContent cacheEntry)
 A 304 not modified response. More...
 
void SetPartialResponse (int start, int end, int total)
 Sets the Content-Range response. More...
 
bool GetRange (out int start, out int end)
 Gets the range request header. More...
 
void Failed (int status)
 Goes straight to ready state 4 and the given status. More...
 
- Public Member Functions inherited from Dom.EventTarget
void ClearEvents ()
 Clears all events on this document. More...
 
bool dispatchEvent (Event e)
 Runs an event of the given name. More...
 
void addEventListener (string name, EventListener listener)
 Adds an event listener to this document. More...
 
void addEventListener (string name, EventListener listener, bool useCapture)
 Adds an event listener to this document. More...
 
void removeEventListener (string name, object evtHandlerInternal)
 Removes an event listener from this document. More...
 
void addEventListener (string name, AnimationEventDelegate method)
 
void addEventListener (string name, AudioProcessingEventDelegate method)
 
void addEventListener (string name, BeforeInputEventDelegate method)
 
void addEventListener (string name, BeforeUnloadEventDelegate method)
 
void addEventListener (string name, BlobEventDelegate method)
 
void addEventListener (string name, ClipboardEventDelegate method)
 
void addEventListener (string name, CloseEventDelegate method)
 
void addEventListener (string name, CompositionEventDelegate method)
 
void addEventListener (string name, CustomEventDelegate method)
 
void addEventListener (string name, CSSFontFaceLoadEventDelegate method)
 
void addEventListener (string name, DeviceLightEventDelegate method)
 
void addEventListener (string name, DeviceMotionEventDelegate method)
 
void addEventListener (string name, DeviceOrientationEventDelegate method)
 
void addEventListener (string name, DeviceProximityEventDelegate method)
 
void addEventListener (string name, DomEventDelegate method)
 
void addEventListener (string name, DOMTransactionEventDelegate method)
 
void addEventListener (string name, DragEventDelegate method)
 
void addEventListener (string name, EditingBeforeInputEventDelegate method)
 
void addEventListener (string name, ErrorEventDelegate method)
 
void addEventListener (string name, FetchEventDelegate method)
 
void addEventListener (string name, FocusEventDelegate method)
 
void addEventListener (string name, GamepadEventDelegate method)
 
void addEventListener (string name, HashChangeEventDelegate method)
 
void addEventListener (string name, IDBVersionChangeEventDelegate method)
 
void addEventListener (string name, InputEventDelegate method)
 
void addEventListener (string name, KeyboardEventDelegate method)
 
void addEventListener (string name, MediaStreamEventDelegate method)
 
void addEventListener (string name, MessageEventDelegate method)
 
void addEventListener (string name, MouseEventDelegate method)
 
void addEventListener (string name, MutationEventDelegate method)
 
void addEventListener (string name, OfflineAudioCompletionEventDelegate method)
 
void addEventListener (string name, PageTransitionEventDelegate method)
 
void addEventListener (string name, PointerEventDelegate method)
 
void addEventListener (string name, PopStateEventDelegate method)
 
void addEventListener (string name, ProgressEventDelegate method)
 
void addEventListener (string name, RelatedEventDelegate method)
 
void addEventListener (string name, RTCDataChannelEventDelegate method)
 
void addEventListener (string name, RTCIdentityErrorEventDelegate method)
 
void addEventListener (string name, RTCIdentityEventDelegate method)
 
void addEventListener (string name, RTCPeerConnectionIceEventDelegate method)
 
void addEventListener (string name, SensorEventDelegate method)
 
void addEventListener (string name, StorageEventDelegate method)
 
void addEventListener (string name, TextEventDelegate method)
 
void addEventListener (string name, TimeEventDelegate method)
 
void addEventListener (string name, TouchEventDelegate method)
 
void addEventListener (string name, TrackEventDelegate method)
 
void addEventListener (string name, TransitionEventDelegate method)
 
void addEventListener (string name, UIEventDelegate method)
 
void addEventListener (string name, UserProximityEventDelegate method)
 
void addEventListener (string name, WebGLContextEventDelegate method)
 
void addEventListener (string name, WheelEventDelegate method)
 
void addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener)
 
void addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener, bool capture)
 
void addEventListener (string name, ContextEventDelegate method)
 
void addEventListener (string name, SlideEventDelegate method)
 
void addEventListener (string name, PowerUI.SpriteEventDelegate method)
 
void addEventListener (string name, SVGEventDelegate method)
 Adds an event listener to this document. More...
 
void addEventListener (string name, SVGZoomEventDelegate method)
 

Public Attributes

AudioFormat Contents
 The contents of this package. A particular format of audio, e.g. a synth track, ogg etc. More...
 
- Public Attributes inherited from PowerUI.ContentPackage
Document hostDocument
 A document to inform when the resource has loaded. More...
 
Location redirectedTo
 A location that the request was redirected to. More...
 
Location location
 The URI that was requested. More...
 
byte[] request
 E.g. posted data. More...
 
string type
 The type of file that was requested (e.g. "woff" or "ttf") More...
 
int statusCode =200
 A HTTP status code if there is one. More...
 
int contentLength
 Total content length. More...
 
int bytesReceived
 Bytes received. More...
 
- Public Attributes inherited from Dom.EventTarget
EventsSet Events
 A set of events for this document. See addEventListener. More...
 

Package Functions

override void ReceivedMovieTexture (MovieTexture tex)
 
override void ReceivedData (byte[] buffer, int offset, int count)
 Called by the file handler when the contents are available. More...
 
- Package Functions inherited from PowerUI.ContentPackage
bool ReceivedHeaders ()
 All headers are ready. Returns true if we're redirecting. More...
 
void ReceivedHeaders (int length)
 All headers are ready. More...
 
bool ReceivedHeaders (string rawHeaders)
 All headers are ready. Returns true if we're redirecting. More...
 
void Done ()
 Goes straight to ready state 4, status 200. More...
 
virtual void ReceivedMovieTexture (UnityEngine.MovieTexture tex)
 

Properties

Type ContentType [get]
 The system type of the content, e.g. OggFormat. More...
 
bool Loaded [get]
 Checks if this package contains something loaded and useable. More...
 
- Properties inherited from PowerUI.ContentPackage
int readyState [get, set]
 Same as XMLHTTPRequest.readyState. More...
 
Headers requestHeaders [get]
 The headers to send with this request. They're lowercase. Status line is indexed as the empty string. More...
 
Headers responseHeaders [get]
 All available headers, parsed as soon as they become available. Status line is indexed as the empty string. More...
 
string rawResponseHeaders [get, set]
 Gets or sets the raw response headers. More...
 
string rawRequestHeaders [get, set]
 Gets or sets the raw response headers. More...
 
string statusText [get]
 The complete response status header. E.g. "HTTP/1.1 200 OK" More...
 
bool started [get]
 True if this request has started up. More...
 
bool ready [get]
 True if this request has at least some data. More...
 
bool ok [get]
 True if there is no error and the text is ok. More...
 
bool errored [get]
 True if there was an error and the text is not ok. More...
 
string contentType [get]
 The response content type. More...
 
float progress [get]
 Download progress. More...
 
int timeout [get, set]
 Timeout in ms. Default is 0. More...
 
UIEventDelegate onreadystatechange [get, set]
 Called when the ready state changes. More...
 
UIEventDelegate onload [get, set]
 Called when it's done loading. More...
 
UIEventDelegate ontimeout [get, set]
 Called when the request times out. More...
 
UIEventDelegate onerror [get, set]
 Called when the request errors. More...
 
UIEventDelegate onabort [get, set]
 Called when the request is aborted. More...
 
- Properties inherited from Dom.EventTarget
static DispatchStack dispatchStackRef [get]
 The active dispatch stack. Use event.deepPath to access it (available during dispatch only). More...
 
virtual EventTarget eventTargetParentNode [get]
 The parent node as used by EventTarget during capture. Can be null. More...
 
virtual NodeList eventTargetChildren [get]
 The childNode set as used by EventTarget during capture. Can be null. More...
 

Private Member Functions

void Clear ()
 Removes all content from this audio package. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PowerUI.ContentPackage
void SetPath (string src, Location relativeTo)
 Sets up the filepath to the given url which may be relative to a given location. More...
 
- Package Attributes inherited from PowerUI.ContentPackage
int readyState_
 Same as XMLHTTPRequest.readyState. More...
 
IAbortable abortableObject
 An internal abortable object. More...
 
- Static Package Attributes inherited from Dom.EventTarget
static DispatchStack PooledStack
 The current head of the pooled dispatched stacks. More...
 

Constructor & Destructor Documentation

PowerUI.AudioPackage.AudioPackage ( string  src)
inline

Creates a new package for the named file to get. The path must be absolute. You must then call PowerUI.AudioPackage.send to perform the request.

Parameters
srcThe file to get.
PowerUI.AudioPackage.AudioPackage ( string  src,
Location  relativeTo 
)
inline

Creates a new package for the named file to get. You must then call PowerUI.AudioPackage.send to perform the request.

Parameters
srcThe file to get.
relativeToThe path the file to get is relative to, if any (may be null).
PowerUI.AudioPackage.AudioPackage ( AudioFormat  contents)
inline

Creates a package for the given already loaded contents.

PowerUI.AudioPackage.AudioPackage ( AudioClip  clip)
inline

Creates an audio package containing the given clip.

Parameters
clipThe clip for this audio package.
PowerUI.AudioPackage.AudioPackage ( string  src,
Location  relativeTo,
AudioClip  clip 
)
inline

Creates an audio package containing the given clip.

Parameters
clipThe clip for this audio package.

Member Function Documentation

void PowerUI.AudioPackage.AssignClip ( AudioClip  clip)
inline

Assign the given clip to this package.

void PowerUI.AudioPackage.Clear ( )
inlineprivate

Removes all content from this audio package.

float PowerUI.AudioPackage.GetCurrentTime ( )
inline

The current time in seconds.

Implements PowerSlide.ITimingLeader.

float PowerUI.AudioPackage.GetDuration ( )
inline

The clip length in seconds. Returns -1 if it's unknown.

Implements PowerSlide.ITimingLeader.

void PowerUI.AudioPackage.GotClip ( AudioClip  clip)
inline

Assigns the given clip to this package, setting it as a 200 OK.

override void PowerUI.AudioPackage.ReceivedData ( byte[]  buffer,
int  offset,
int  count 
)
inlinepackagevirtual

Called by the file handler when the contents are available.

Reimplemented from PowerUI.ContentPackage.

override void PowerUI.AudioPackage.ReceivedMovieTexture ( MovieTexture  tex)
inlinepackage
void PowerUI.AudioPackage.send ( )
inline

Sends the request off. Callbacks such as onreadystatechange will be triggered.

void PowerUI.AudioPackage.Start ( Dom.Node  context)
inline

Called when this audio should now begin.

void PowerUI.AudioPackage.Stop ( )
inline

Called when this audio is no longer being displayed.

Implements PowerSlide.ITimingLeader.

Member Data Documentation

AudioFormat PowerUI.AudioPackage.Contents

The contents of this package. A particular format of audio, e.g. a synth track, ogg etc.

Property Documentation

Type PowerUI.AudioPackage.ContentType
get

The system type of the content, e.g. OggFormat.

bool PowerUI.AudioPackage.Loaded
get

Checks if this package contains something loaded and useable.

Returns
True if there is a useable graphic in this package.