root/trunk/whisperer/media_server.rpc

// Copyright (c) 2009, Whispersoft s.r.l.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Whispersoft s.r.l. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: Mihai Ianculescu
//
//
// Defines types used for defining/controlling stream providers
//
//////////////////////////////////////////////////////////////////////

Type WhispererSpecAccessStruct {
  string remote_user_;
  string remote_password_;
}

Type ProviderSpec {
  string name_;
  string description_;
  // needed only if the provider is providing more than 1 audio port
  optional int audio_ports_;
  // needed only if the provider is providing more than 1 video port
  optional int video_ports_;
  // needed only if the provider is actually relaying unparsed data
  optional string mime_type_;
  // in miliseconds, defaults are set through command line
  optional int source_fireup_timeout_;
  optional int encoder_fireup_timeout_;
  optional int source_idle_timeout_;
  optional int encoder_idle_timeout_;
  // in bytes. default is set through command line
  optional int max_lag_;
  // an array of names of GStreamer elements that can be controlled through RPC
  optional array<string> controlled_elements_;
  // who has access to this provider (if empty => everyone)
  optional array<WhispererSpecAccessStruct> access_data_;
}

Type PublishSpec {
  string url_;
  // in miliseconds, default is set through command line
  optional int retry_timeout_;

  // How to connect to the remote server
  optional WhispererSpecAccessStruct user_;
}

//////////////////////////////////////////////////////////////////////

Type MediaServerResult {
  int result_;   // 0 -> OK
  optional string description_;
}

//////////////////////////////////////////////////////////////////////

Service MediaProviderService {
  MediaServerResult AddProvider(ProviderSpec spec);
  MediaServerResult RemoveProvider(string name);
  array<ProviderSpec> ListProviders();

  MediaServerResult Publish(PublishSpec spec);
  MediaServerResult Unpublish(string url);
  array<PublishSpec> ListPublished();

  bool SaveConfig();
}

//////////////////////////////////////////////////////////////////////