| 3 | == Writing an OMF Application Wrapper == |
| 4 | |
| 5 | |
| 6 | When an OML-enabled application is run using OMF, the application itself is installed on the resource and a simple [https://mytestbed.net/projects/omf/wiki/BasicTutorialStage3-5-2 OMF application wrapper] is installed on the console where the OMF Experiment Controller runs. This wrapper just gives some basic information about the application, the parameters that can be passed at the command line, and the OML measurement points that have been defined in the application: |
| 7 | |
| 8 | |
| 9 | {{{ |
| 10 | #!ruby |
| 11 | defApplication('vlc-dash') do |app| |
| 12 | |
| 13 | app.path = "/usr/local/bin/vlc" |
| 14 | app.version(2, 1, 0) |
| 15 | app.shortDescription = "VLC" |
| 16 | app.description = "VLC multimedia player and streamer" |
| 17 | |
| 18 | |
| 19 | app.defProperty("input", "Stream input (e.g. file or network address)", nil, |
| 20 | {:type => :string, :dynamic => false, :use_name => false}) |
| 21 | app.defProperty("sout", "Stream output", "--sout", |
| 22 | {:type => :string, :dynamic => false,}) |
| 23 | app.defProperty("intf", "Main interface module", "--intf", |
| 24 | {:type => :string, :dynamic => false}) |
| 25 | app.defProperty("extraintf", "Extra interface module(s). Use --extraintf omlstats to enable OML", "--extraintf", |
| 26 | {:type => :string, :dynamic => false}) |
| 27 | app.defProperty("mtu", "Specifies the MTU of the network interface", "--mtu", |
| 28 | {:type => :string, :dynamic => false}) |
| 29 | app.defProperty("quiet", " Deactivates all console messages", "--quiet", |
| 30 | {:type => :boolean, :dynamic => false}) |
| 31 | app.defProperty("play-and-exit", "Exit VLC after playing all the items in the input stream list", "--play-and-exit", |
| 32 | {:type => :boolean, :dynamic => false}) |
| 33 | app.defProperty("redirect", "Redirect stdout and stderr to /dev/null", " > /dev/null 2>&1", |
| 34 | {:type => :boolean, :dynamic => false, :order => 100}) |
| 35 | |
| 36 | app.defMeasurement('dashRateAdaptation') do |mp| |
| 37 | mp.defMetric('chosenRate_bps',:int) |
| 38 | mp.defMetric('empiricalRate_bps',:int) |
| 39 | mp.defMetric('decisionRate_bps',:int) |
| 40 | mp.defMetric('buffer_percent',:int) |
| 41 | end |
| 42 | |
| 43 | app.defMeasurement('dashDlSession') do |mp| |
| 44 | mp.defMetric('chunkCount',:int) |
| 45 | mp.defMetric('readSession_B',:int) |
| 46 | mp.defMetric('readChunk_B',:int) |
| 47 | mp.defMetric('timeSession_s',:float) |
| 48 | mp.defMetric('timeChunk_s',:float) |
| 49 | end |
| 50 | |
| 51 | end |
| 52 | }}} |