Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## cnrg.itx.gtwy
Class PlayDestination

    java.lang.Object
      |
      +--cnrg.itx.gtwy.PlayDestination

public class PlayDestination
extends java.lang.Object
implements cnrg.itx.datax.Destination

The user-defined destination of voice data packets from the computer network to the gateway.

See Also:
  `PlayChannel`, `Destination`

Constructor Summary
`PlayDestination(Line l, ChannelControl cc)`

Method Summary
`void` | `close()` Used to close the destination to receiving voice packets.
`Line` | `getLine()`
`cnrg.itx.datax.PropertiesCollection` | `getProperties()` The Gateway is not concerned about properties.
`cnrg.itx.datax.Stats` | `getStatistics()`
`boolean` | `mute(boolean mode)` Used to mute the voice data sent to the destination.
`void` | `setPeerProperties(cnrg.itx.datax.PropertiesCollection pc)` The Gateway does not set peer properties.
`void` | `setProperties(cnrg.itx.datax.PropertiesCollection pc)` No properties are set.
`void` | `write(byte[] data)` Writes voice data to a specified buffer on the gateway.

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

Constructor Detail

### PlayDestination

    public PlayDestination(Line l,
                           ChannelControl cc)

  Parameters:
    `l` - the `Line` instance related to `PlayDestination`.
    `cc` - the `ChannelControl` instance for calling native code.
  See Also:
    `Line`, `ChannelControl`

Method Detail

### getLine

    public Line getLine()

  Returns:
    the `Line` instance for `PlayDestination`
  See Also:
    `Line`

### close

    public void close()

  Used to close the destination to receiving voice packets.
  Specified by:
    close in interface cnrg.itx.datax.Destination

### mute

    public boolean mute(boolean mode)

  Used to mute the voice data sent to the destination.
  Specified by:
    mute in interface cnrg.itx.datax.Destination
  Parameters:
    `mode` - true if the destination has to be muted; false otherwise.
  Returns:
    true if the destination has been muted; false otherwise.

### write

    public void write(byte[] data)
               throws cnrg.itx.datax.DataException

  Writes voice data to a specified buffer on the gateway. Data will be played out on a phone later on.
  Specified by:
    write in interface cnrg.itx.datax.Destination
  Parameters:
    `data` - the voice data.

### getProperties

    public cnrg.itx.datax.PropertiesCollection getProperties()
                                                      throws cnrg.itx.datax.DataException

  The Gateway is not concerned about properties. Returns null.

### setProperties

    public void setProperties(cnrg.itx.datax.PropertiesCollection pc)
                       throws cnrg.itx.datax.DataException

  No properties are set.

### setPeerProperties

    public void setPeerProperties(cnrg.itx.datax.PropertiesCollection pc)
                           throws cnrg.itx.datax.DataException

  The Gateway does not set peer properties.

### getStatistics

    public cnrg.itx.datax.Stats getStatistics()

  Returns:
    the Stats object which describes the current state of the destination.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD