Python LMF library
 All Classes Namespaces Files Functions Variables
Public Member Functions | Public Attributes | List of all members
pylmflib.pylmflib.resources.audio.Audio Class Reference

Audio is a Material subclass representing an audio recording. More...

Inheritance diagram for pylmflib.pylmflib.resources.audio.Audio:

Public Member Functions

def __init__
 Constructor. More...
 
def __del__
 Destructor. More...
 
def set_mediaType
 Set media type. More...
 
def get_mediaType
 Get media type. More...
 
def set_fileName
 Set file name. More...
 
def get_fileName
 Get file name. More...
 
def set_author
 Set author of the material resource. More...
 
def get_author
 Get author of the material resource. More...
 
def set_quality
 Set audio recording quality. More...
 
def get_quality
 Get audio recording quality. More...
 
def set_sound
 Set sound. More...
 
def get_sound
 Get sound. More...
 
def set_transcription
 Set transcription of the audio recording. More...
 
def get_transcription
 Get transcription of the audio recording. More...
 
def set_startPosition
 Set start position. More...
 
def get_startPosition
 Get start position. More...
 
def set_durationOfEffectiveSpeech
 Set duration of effective speech. More...
 
def get_durationOfEffectiveSpeech
 Get duration of effective speech. More...
 
def set_externalReference
 Set external reference. More...
 
def get_externalReference
 Get external reference. More...
 
def set_audioFileFormat
 Set audio file format. More...
 
def get_audioFileFormat
 Get audio file formay. More...
 

Public Attributes

 quality
 
 sound
 
 startPosition
 
 durationOfEffectiveSpeech
 
 externalReference
 
 audioFileFormat
 
 transcription
 
 mediaType
 
 fileName
 
 author
 

Detailed Description

Audio is a Material subclass representing an audio recording.

Definition at line 11 of file audio.py.

Constructor & Destructor Documentation

def pylmflib.pylmflib.resources.audio.Audio.__init__ (   self)

Constructor.

Audio instances are owned by FormRepresentation.

Returns
An Audio instance.

Definition at line 14 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.__del__ (   self)

Destructor.

Definition at line 29 of file audio.py.

Member Function Documentation

def pylmflib.pylmflib.resources.audio.Audio.get_audioFileFormat (   self)

Get audio file formay.

Returns
Audio attribute 'audioFileFormat'.

Definition at line 199 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_author (   self)

Get author of the material resource.

Returns
Audio attribute 'author'.

Definition at line 76 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_durationOfEffectiveSpeech (   self)

Get duration of effective speech.

Returns
Audio attribute 'durationOfEffectiveSpeech'.

Definition at line 167 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_externalReference (   self)

Get external reference.

Returns
Audio attribute 'externalReference'.

Definition at line 183 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_fileName (   self)

Get file name.

Returns
Audio attribute 'fileName'.

Definition at line 60 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_mediaType (   self)

Get media type.

Returns
Audio attribute 'mediaType'.

Definition at line 44 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_quality (   self)

Get audio recording quality.

Returns
Audio attribute 'quality'.

Definition at line 92 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_sound (   self)

Get sound.

Returns
Audio attribute 'sound'.

Definition at line 108 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_startPosition (   self)

Get start position.

Returns
Audio attribute 'startPosition'.

Definition at line 144 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.get_transcription (   self)

Get transcription of the audio recording.

Returns
Audio attribute 'transcription'.

Definition at line 124 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_audioFileFormat (   self,
  audio_file_format 
)

Set audio file format.

Parameters
audio_file_formatAudio file format to set.
Returns
Audio instance.

Definition at line 189 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_author (   self,
  author 
)

Set author of the material resource.

Parameters
authorAuthor to set.
Returns
Audio instance.

Definition at line 66 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_durationOfEffectiveSpeech (   self,
  duration 
)

Set duration of effective speech.

Parameters
durationDuration of effective speech to set.
Returns
Audio instance.

Definition at line 150 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_externalReference (   self,
  external_reference 
)

Set external reference.

Parameters
external_referenceExternal reference to set.
Returns
Audio instance.

Definition at line 173 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_fileName (   self,
  file_name 
)

Set file name.

Parameters
file_nameName to set.
Returns
Audio instance.

Definition at line 50 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_mediaType (   self,
  media_type 
)

Set media type.

Parameters
media_typeType to set.
Returns
Audio instance.

Definition at line 34 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_quality (   self,
  quality 
)

Set audio recording quality.

Parameters
qualityQuality to set.
Returns
Audio instance.

Definition at line 82 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_sound (   self,
  sound 
)

Set sound.

Parameters
soundSound to set.
Returns
Audio instance.

Definition at line 98 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_startPosition (   self,
  start_position 
)

Set start position.

Parameters
start_positionStart position to set.
Returns
Audio instance.

Definition at line 130 of file audio.py.

def pylmflib.pylmflib.resources.audio.Audio.set_transcription (   self,
  transcription 
)

Set transcription of the audio recording.

Parameters
Transcriptionto set.
Returns
Audio instance.

Definition at line 114 of file audio.py.

Member Data Documentation

pylmflib.pylmflib.resources.audio.Audio.audioFileFormat

Definition at line 26 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.author

Definition at line 73 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.durationOfEffectiveSpeech

Definition at line 24 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.externalReference

Definition at line 25 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.fileName

Definition at line 57 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.mediaType

Definition at line 41 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.quality

Definition at line 21 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.sound

Definition at line 22 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.startPosition

Definition at line 23 of file audio.py.

pylmflib.pylmflib.resources.audio.Audio.transcription

Definition at line 27 of file audio.py.


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