WebAudioDepictor (Guise Framework 0.4.0 API)

java.lang.Object
- io.guise.framework.platform.AbstractDepictor<O>
- - io.guise.framework.platform.web.AbstractWebDepictor<Audio>
  - - io.guise.framework.platform.web.WebAudioDepictor

All Implemented Interfaces:

Audio.Depictor<Audio>, Depictor<Audio>
```
public class WebAudioDepictor
extends AbstractWebDepictor<Audio>
implements Audio.Depictor<Audio>
```
A web depictor for Guise audio.

Author:

Garret Wilson

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class WebAudioDepictor.AudioCommand
The web commands for controlling audio.
- Nested classes/interfaces inherited from class io.guise.framework.platform.AbstractDepictor
  AbstractDepictor.DepictedPropertyChangeListener

Field Summary
- Fields inherited from interface io.guise.framework.platform.Depictor
  GENERAL_PROPERTY

Constructor Summary

Constructors
Constructor Description

WebAudioDepictor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`pause()`	Requests that the audio pause.
`void`	`play()`	Requests that the audio start playing.
`void`	`processEvent(PlatformEvent event)`	Processes an event from the platform.
`void`	`setTimePosition(long newTimePosition)`	Requests a new time-based play position.
`void`	`stop()`	Requests that the audio stop.

Methods inherited from class io.guise.framework.platform.web.AbstractWebDepictor
getPlatform

Methods inherited from class io.guise.framework.platform.AbstractDepictor
depict, depictedObjectPropertyChange, getDepictContext, getDepictedObject, getDepictedPropertyChangeListener, getIgnoredProperties, getModifiedProperties, getSession, installed, isDepicted, setDepicted, setPropertyModified, uninstalled

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.guise.framework.platform.Depictor
depict, getDepictContext, getDepictedObject, getPlatform, getSession, installed, isDepicted, setDepicted, uninstalled

- Constructor Detail
  - WebAudioDepictor
```
public WebAudioDepictor()
```
- Method Detail
  - play
```
public void play()
```
    Description copied from interface: Audio.Depictor
    
    Requests that the audio start playing.
    
    Specified by:
    
    play in interface Audio.Depictor<Audio>
  - pause
```
public void pause()
```
    Description copied from interface: Audio.Depictor
    
    Requests that the audio pause.
    
    Specified by:
    
    pause in interface Audio.Depictor<Audio>
  - stop
```
public void stop()
```
    Description copied from interface: Audio.Depictor
    
    Requests that the audio stop.
    
    Specified by:
    
    stop in interface Audio.Depictor<Audio>
  - setTimePosition
```
public void setTimePosition(long newTimePosition)
```
    Description copied from interface: Audio.Depictor
    
    Requests a new time-based play position.
    
    Specified by:
    
    setTimePosition in interface Audio.Depictor<Audio>
    
    Parameters:
    
    newTimePosition - The new play position in microseconds.
  - processEvent
```
public void processEvent(PlatformEvent event)
```
    Description copied from interface: Depictor
    
    Processes an event from the platform.
    
    Specified by:
    
    processEvent in interface Depictor<Audio>
    
    Overrides:
    
    processEvent in class AbstractDepictor<Audio>
    
    Parameters:
    
    event - The event to be processed.