Meego Wiki
Views

UMMS User Manual

From MeeGo wiki
(Difference between revisions)
Jump to: navigation, search
(API Reference)
(API Reference)
Line 24: Line 24:
''Interface com.UMMS.ObjectManager.iface''
''Interface com.UMMS.ObjectManager.iface''
   Methods:
   Methods:
 +
   RequestMediaPlayer(s(out): object_path)
   RequestMediaPlayer(s(out): object_path)
 +
    Request a ''MediaPlayer'' object operate in attended-execution mode. The ''ObjectManager'' will creat a new ''MediaPlayer'' object,
 +
    register it on the bus and return the object path to client.
 +
    parameters:
 +
        object_path(out): The object path belong to the newly created ''MediaPlayer'' object.
 +
   RequestMediaPlayerUnattended(d: time_to_execution, s(out): token, s(out): object_path)
   RequestMediaPlayerUnattended(d: time_to_execution, s(out): token, s(out): object_path)
 +
   RemoveMediaPlayer(s: object_path)
   RemoveMediaPlayer(s: object_path)
      
      
Line 31: Line 38:
   Methods:
   Methods:
   SetUri(s: uri)
   SetUri(s: uri)
 +
  SetTarget(i: type, a{sv}: param)
   Play()
   Play()
   Pause()
   Pause()

Revision as of 15:23, 17 November 2011

Contents

UMMS User Manual and Sample code

Introduction

This page provides the User Manual and some sample code for the Universal Multi Media Service (UMMS).
UMMS general description can found on its main page

Service Name

com.UMMS

Objects and Interfaces

ObjectManager: Object to create and remove MediaPlayer object.

 Path:      /com/UMMS/ObjectManager
 Interface: com.UMMS.ObjectManager.iface

MediaPlayer: Player object to control the playback of media assets.

 Path:      Returned by ObjectManager
 Interface: com.UMMS.MediaPlayer

AudioManager: Object to manage the system audio output.

 Path:      /com/UMMS/AudioManager
 Interface: com.UMMS.AudioManger

API Reference

Interface com.UMMS.ObjectManager.iface

 Methods:
  RequestMediaPlayer(s(out): object_path)
    Request a MediaPlayer object operate in attended-execution mode. The ObjectManager will creat a new MediaPlayer object,
    register it on the bus and return the object path to client.
    parameters: 
        object_path(out): The object path belong to the newly created MediaPlayer object.
  RequestMediaPlayerUnattended(d: time_to_execution, s(out): token, s(out): object_path)
  RemoveMediaPlayer(s: object_path)
   

Interface com.UMMS.MediaPlayer

 Methods:
  SetUri(s: uri)
  SetTarget(i: type, a{sv}: param)
  Play()
  Pause()
  Stop()
  SetPosition(x: pos)
  GetPosition(x(out): pos)
  SetPlaybackRate(d: rate)
  GetPlaybackRate(d(out): rate)
  SetVolume(i: volume)
  GetVolume(i(out): volume)
  SetVideoSize(u: x, u: y, u: w, u: h)
  GetVideoSize(u(out): w, u(out): h)
  GetBufferedTime(x(out): length_time)
  GetBufferedBytes(x(out): length_byte)
  GetMediaSizeTime(x(out): duration)
  GetMediaSizeBytes(x(out): size)
  HasVideo(b(out): has_video)
  HasAudio(b(out): has_audio)
  IsStreaming(b(out): is_stream)
  IsSeekable(b(out): is_seekable)
  SupportFullScreen(b(out): support_fullscreen)
  GetPlayerState(i(out): current_state)
  Reply()
  SetProxy(a{sv}: param)
  Suspend()
  Restore()
  GetCurrentVideo(i(out): current_video)
  GetCurrentAudio(i(out): current_audio)
  SetCurrentVideo(i: current_video)
  SetCurrentAudio(i: current_audio)
  GetVideoNum(i(out): video_num)
  GetAudioNum(i(out): audio_num)
  SetSubtitleUri(s: sub_uri)
  SetCurrentSubtitle(i: current_sub)
  GetCurrentSubtitle(i(out): current_sub)
  SetBufferDepth(i: format, x: buf_depth)
  GetBufferDepth(i: format, x(out): buf_depth)
  SetMute(i: is_mute)
  IsMute(i(out): is_mute)
  SetScaleMode(i: mode)
  GetScaleMode(i(out): mode)
  GetVideoCodec(i: channel, s(out): video_codec)
  GetAudioCodec(i: channel, s(out): audio_codec)
  GetVideoBitrate(i: channel, i(out): video_bitrate)
  GetAudioBitrate(i: channel, i(out): audio_bitrate)
  GetEncapsulation(s(out): encapsulation)
  GetAudioSampleRate(i: channel, i(out): sample_rate)
  GetVideoFrameRate(i: channel, i(out): frame_rate_num, i(out): frame_rate_denum)
  GetVideoResolution(i: channel, i(out): width, i(out): height)
  GetVideoAspectRatio(i: channel, i(out): ratio_num, i(out): ratio_denum)
  GetProtocolName(s(out): protocol_name)
  Record(b: to_record, s: location)
  GetPat(aa{sv}(out): pat)
  GetPmt(u(out): program_number, u(out): pcr_pid, aa{sv}(out): stream_info)
  GetCurrentUri(s(out): current_uri)
  GetAssociatedDataChannel(s(out): ip, i(out): port)
 
 Signals:
  Initialized
  Eof
  Error(u: id, s: message)
  Buffering
  Buffered
  RequestWindow
  Seeked
  Stopped
  PlayerStateChanged(i: old_state, i: new_state)
  NeedReply
  TargetReady(a{sv}: info)
  Suspended
  Restored
  NoResource
  VideoTagChanged(i: video_number)
  AudioTagChanged(i: audio_number)
  TextTagChanged(i: text_number)

Interface: com.UMMS.AudioManger

 Methods:
  SetVolume(i: output_type, i: volume)
  GetVolume(i: output_type, i(out): volume)
  SetState(i: output_type, i: state)
  GetState(i: output_type, i(out): state)

Sample Code

Personal tools