Methods' Summary |
start |
starts reading the stream from the current position.
|
stop |
stops reading the stream and leave the cursor at its current
position.
|
isPlaying |
indicates whether the stream is played or not.
|
getDuration |
gets the stream length
|
setMediaTime |
sets the new cursor position in the media stream. After using
this method the stream is stopped.
|
getMediaTime |
gets the current position of the cursor in the stream
|
setPlaybackLoop |
sets whether the stream reading should restart at the stream
start after the end of the stream.
|
isPlaybackLoop |
indicates whether the stream reading will restart after the
end of the stream.
|
setVolumeDB |
sets the audio volume in decibel.
|
getVolumeDB |
gets the current audio volume in decibel
|
setMute |
sets the volume to 0 or to its previous value.
|
isMute |
gets whether the volume is temporarily down to 0
or not.
|
getPreferredPlayerWindowSize |
gets the preferred window size
|
createPlayerWindow |
gets a new player window for this stream control
|
createFrameGrabber |
gets a frame grabber for this stream.
|
Methods' Details |
start
- Description
- starts reading the stream from the current position.
|
|
stop
- Description
- stops reading the stream and leave the cursor at its current
position.
|
|
isPlaying
- Description
- indicates whether the stream is played or not.
- Returns
- `TRUE` if the stream is played, `FALSE` otherwise
|
|
getDuration
- Description
- gets the stream length
- Returns
- the stream length in second
|
|
setMediaTime
void |
setMediaTime( |
[in] double |
fTime ); |
- Description
- sets the new cursor position in the media stream. After using
this method the stream is stopped.
- Parameter fTime
- the new position to set in seconds
|
|
getMediaTime
- Description
- gets the current position of the cursor in the stream
- Returns
- the cursor position in seconds
|
|
setPlaybackLoop
void |
setPlaybackLoop( |
[in] boolean |
bSet ); |
- Description
- sets whether the stream reading should restart at the stream
start after the end of the stream.
- Parameter bSet
- loops if set to `TRUE`, otherwise stops at the end of the
stream.
|
|
isPlaybackLoop
boolean |
isPlaybackLoop(); |
- Description
- indicates whether the stream reading will restart after the
end of the stream.
- Returns
- `TRUE` if the stream will loop, `FALSE` otherwise.
|
|
setVolumeDB
void |
setVolumeDB( |
[in] short |
nDB ); |
- Description
- sets the audio volume in decibel.
- Parameter nDB
- the new volume in Decibel
|
|
getVolumeDB
- Description
- gets the current audio volume in decibel
- Returns
- the volume in decibel
|
|
setMute
void |
setMute( |
[in] boolean |
bSet ); |
- Description
- sets the volume to
0 or to its previous value.
- Parameter bSet
- sets the volume to
0 if `TRUE`, and switch
to the previous non-null value if `FALSE`
|
|
isMute
- Description
- gets whether the volume is temporarily down to
0
or not.
- Returns
- `TRUE` if the volume is temporarily set to
0 ,
`FALSE` otherwise.
|
|
getPreferredPlayerWindowSize
::com::sun::star::awt::Size |
getPreferredPlayerWindowSize(); |
- Description
- gets the preferred window size
- Returns
- the com::sun::star::awt::Size
|
|
createPlayerWindow
XPlayerWindow |
createPlayerWindow( |
[in] sequence< any > |
aArguments ); |
- Description
- gets a new player window for this stream control
- Parameter aArguments
- arguments passed to the window during its creation.
|
|
createFrameGrabber
- Description
- gets a frame grabber for this stream.
|
|
Copyright © 2020, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.