third_party/WebKit/public/platform/WebMIDIAccessorClient.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebMIDIAccessorClient_h
  32 #define WebMIDIAccessorClient_h
  33
  34 #include "WebString.h"
  35
  36 namespace blink {
  37
  38 class WebMIDIAccessorClient {
  39 public:
  40     enum MIDIPortState {
  41         MIDIPortStateDisconnected,
  42         MIDIPortStateConnected,
  43     };
  44
  45     // didAddInputPort() and didAddOutputPort() can be called before and after
  46     // didStartSession() is called. But |id| should be unique in each function.
  47     virtual void didAddInputPort(const WebString& id, const WebString& manufacturer, const WebString& name, const WebString& version, MIDIPortState) = 0;
  48     virtual void didAddOutputPort(const WebString& id, const WebString& manufacturer, const WebString& name, const WebString& version, MIDIPortState) = 0;
  49     // didSetInputPortState() and didSetOutputPortState() should not be called
  50     // until didStartSession() is called.
  51     virtual void didSetInputPortState(unsigned portIndex, MIDIPortState) = 0;
  52     virtual void didSetOutputPortState(unsigned portIndex, MIDIPortState) = 0;
  53
  54     virtual void didStartSession(bool success, const WebString& error, const WebString& message) = 0;
  55
  56     // |timeStamp| is in milliseconds according to the Web MIDI API.
  57     virtual void didReceiveMIDIData(unsigned portIndex, const unsigned char* data, size_t length, double timeStamp) = 0;
  58
  59 protected:
  60     virtual ~WebMIDIAccessorClient() { }
  61 };
  62
  63 } // namespace blink
  64
  65 #endif // WebMIDIAccessorClient_h