MeiCam SDK For Android  1.0.0
Public Member Functions | List of all members
com.meicam.sdk.NvsAudioClip Class Reference

Audio clip, description of the audio file. More...

Inheritance diagram for com.meicam.sdk.NvsAudioClip:
com.meicam.sdk.NvsClip com.meicam.sdk.NvsObject

Public Member Functions

NvsAudioFx appendFx (String fxName)
 Adds an audio effect to the end of the audio clip. More...
 
NvsAudioFx insertFx (String fxName, int fxIndex)
 Inserts an audio effect at the specified effect index on the audio clip. More...
 
boolean removeFx (int fxIndex)
 Removes audio effect by index. More...
 
NvsAudioFx getFxByIndex (int fxIndex)
 Gets audio effect by index. More...
 
void setFadeInDuration (long duration)
 Sets the fade-in time. More...
 
long getFadeInDuration ()
 Gets fade-in time. More...
 
void setFadeOutDuration (long duration)
 Sets fade-out time. More...
 
long getFadeOutDuration ()
 Gets fade-out time. More...
 
- Public Member Functions inherited from com.meicam.sdk.NvsClip
long getTrimIn ()
 Gets the trim in point of the clip. More...
 
long getTrimOut ()
 Gets the trim out point of the clip. More...
 
long getInPoint ()
 Gets the in-point of the clip on the timeline. More...
 
long getOutPoint ()
 Gets the out-point of the clip on the timeline. More...
 
int getType ()
 Gets the clip type (video clip, audio clip). More...
 
int getIndex ()
 Gets the index of the clip on the track. More...
 
String getFilePath ()
 Gets the clip file path. More...
 
int getFxCount ()
 Gets the number of effects on the clip. Note: The effect index on the clip starts from 0. More...
 
long changeTrimInPoint (long newTrimInPoint, boolean affectSibling)
 Modifies the trim in point of the clip. More...
 
long changeTrimOutPoint (long newTrimOutPoint, boolean affectSibling)
 Modifies the trim out point of the clip. More...
 
double getSpeed ()
 Get the playback speed of the clip. More...
 
void changeSpeed (double newSpeed)
 Changes the playback speed of the clip. More...
 
void changeSpeed (double newSpeed, boolean keepAudioPitch)
 Changes the playback speed of the clip. More...
 
void setVolumeGain (float leftVolumeGain, float rightVolumeGain)
 Sets the volume. More...
 
NvsVolume getVolumeGain ()
 Gets volume. More...
 
- Public Member Functions inherited from com.meicam.sdk.NvsObject
void setAttachment (String key, Object value)
 Adds additional data to the NvsObject object to identify the NvsObject object or for other purpose. More...
 
Object getAttachment (String key)
 Gets an attachment to NvsObject. More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.meicam.sdk.NvsClip
static final int CLIP_TYPE_VIDEO = 0
 video clip type More...
 
static final int CLIP_TYPE_AUDIO = 1
 audio clip type More...
 
- Protected Member Functions inherited from com.meicam.sdk.NvsObject
void setInternalObject (long internalObject)
 
long getInternalObject ()
 
- Protected Attributes inherited from com.meicam.sdk.NvsObject
long m_internalObject = 0
 

Detailed Description

Audio clip, description of the audio file.

Audio clips can modify trim in and out points, playback speed, etc. Users can also add, insert, remove, and acquire multiple audio effects.

Warning
In the NvsAudioClip class, all public APIs are used in the UI thread! ! !

Member Function Documentation

NvsAudioFx com.meicam.sdk.NvsAudioClip.appendFx ( String  fxName)
inline

Adds an audio effect to the end of the audio clip.

Parameters
fxNameAudio effect name. For the effect name, please refer to getAllBuiltinAudioFxNames() or built-in effect name list.
Returns
Returns the appended audio effect object.
Warning
This interface causes the streaming engine state to jump to the engine stop state. For more infomations please refer to Engine Changes.
See also
insertFx
removeFx
getFxByIndex
long com.meicam.sdk.NvsAudioClip.getFadeInDuration ( )
inline

Gets fade-in time.

Returns
Returns the fade-in time in microseconds.
Since
1.16.0
See also
setFadeInDuration
long com.meicam.sdk.NvsAudioClip.getFadeOutDuration ( )
inline

Gets fade-out time.

Returns
Returns the fade-out time in microseconds.
Since
1.16.0
See also
getFadeOutDuration
NvsAudioFx com.meicam.sdk.NvsAudioClip.getFxByIndex ( int  fxIndex)
inline

Gets audio effect by index.

Parameters
fxIndexAudio effect's index.
Returns
Returns the acquired audio effect object.
See also
appendFx
insertFx
removeFx
NvsAudioFx com.meicam.sdk.NvsAudioClip.insertFx ( String  fxName,
int  fxIndex 
)
inline

Inserts an audio effect at the specified effect index on the audio clip.

Parameters
fxNameAudio effect name. For information about getting all effects' names, please refer to getAllBuiltinAudioFxNames() or built-in effect name list.
fxIndexaudio effects' index to insert at.
Returns
Returns the inserted audio effect object.
Warning
This interface will cause the streaming engine state to jump to the engine stop state. For more information, please refer to Engine Change.
See also
appendFx
removeFx
getFxByIndex
boolean com.meicam.sdk.NvsAudioClip.removeFx ( int  fxIndex)
inline

Removes audio effect by index.

Parameters
fxIndexAudio effects' index.
Returns
Determines if the audio effect is removed successfully. true means a successfull removal, false means failure.
Warning
This interface causes the streaming engine state to jump to the engine stop state, as described in Engine Changes.
See also
appendFx
insertFx
getFxByIndex
void com.meicam.sdk.NvsAudioClip.setFadeInDuration ( long  duration)
inline

Sets the fade-in time.

Parameters
durationFade-in duration in microseconds, 0 means no fade-in.
Since
1.16.0
See also
getFadeInDuration
void com.meicam.sdk.NvsAudioClip.setFadeOutDuration ( long  duration)
inline

Sets fade-out time.

Parameters
durationFade-out duration in microseconds, 0 means no fade-out.
Since
1.16.0
See also
setFadeOutDuration

The documentation for this class was generated from the following file: