git.maemo.org Git - theonering/blob - src/tp/_generated/Channel_Interface_DTMF.py

   1 # -*- coding: utf-8 -*-
   2 # Generated from the Telepathy spec
   3 """Copyright (C) 2005, 2006 Collabora Limited
   4 Copyright (C) 2005, 2006 Nokia Corporation
   5 Copyright (C) 2006 INdT
   6
   7     This library is free software; you can redistribute it and/or
   8 modify it under the terms of the GNU Lesser General Public
   9 License as published by the Free Software Foundation; either
  10 version 2.1 of the License, or (at your option) any later version.
  11
  12 This library is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 Lesser General Public License for more details.
  16
  17 You should have received a copy of the GNU Lesser General Public
  18 License along with this library; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20
  21 """
  22
  23 import dbus.service
  24
  25
  26 class ChannelInterfaceDTMF(dbus.service.Interface):
  27     """\
  28       An interface that gives a Channel the ability to send DTMF events over
  29       audio streams which have been established using the StreamedMedia channel
  30       type. The event codes used are in common with those defined in RFC4733, and are
  31       listed in the DTMF_Event enumeration.
  32     """
  33
  34     def __init__(self):
  35         self._interfaces.add('org.freedesktop.Telepathy.Channel.Interface.DTMF')
  36
  37     @dbus.service.method('org.freedesktop.Telepathy.Channel.Interface.DTMF', in_signature='uy', out_signature='')
  38     def StartTone(self, Stream_ID, Event):
  39         """
  40         Start sending a DTMF tone on this stream. Where possible, the tone
  41         will continue until StopTone is called.
  42         On certain protocols, it may
  43         only be possible to send events with a predetermined length. In this
  44         case, the implementation may emit a fixed-length tone, and the StopTone
  45         method call should return NotAvailable.
  46
  47         """
  48         raise NotImplementedError
  49
  50     @dbus.service.method('org.freedesktop.Telepathy.Channel.Interface.DTMF', in_signature='u', out_signature='')
  51     def StopTone(self, Stream_ID):
  52         """
  53         Stop sending any DTMF tone which has been started using the
  54         StartTone
  55         method. If there is no current tone, this method will do nothing.
  56
  57         """
  58         raise NotImplementedError
  59