Home | History | Annotate | Download | only in platform
      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
      6  * are met:
      7  *  * Redistributions of source code must retain the above copyright
      8  *    notice, this list of conditions and the following disclaimer.
      9  *  * Redistributions in binary form must reproduce the above copyright
     10  *    notice, this list of conditions and the following disclaimer in the
     11  *    documentation and/or other materials provided with the distribution.
     12  *
     13  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
     17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef WebSpeechSynthesisUtterance_h
     27 #define WebSpeechSynthesisUtterance_h
     28 
     29 #include "WebCommon.h"
     30 #include "WebPrivatePtr.h"
     31 #include "WebString.h"
     32 
     33 namespace WebCore { class PlatformSpeechSynthesisUtterance; }
     34 
     35 namespace blink {
     36 
     37 class WebSpeechSynthesisUtterance {
     38 public:
     39     WebSpeechSynthesisUtterance() { }
     40     WebSpeechSynthesisUtterance(const WebSpeechSynthesisUtterance& other) { assign(other); }
     41     ~WebSpeechSynthesisUtterance() { reset(); }
     42 
     43     WebSpeechSynthesisUtterance& operator=(const WebSpeechSynthesisUtterance& other)
     44     {
     45         assign(other);
     46         return *this;
     47     }
     48 
     49     BLINK_PLATFORM_EXPORT void assign(const WebSpeechSynthesisUtterance&);
     50     BLINK_PLATFORM_EXPORT void reset();
     51     bool isNull() const { return m_private.isNull(); }
     52 
     53     BLINK_PLATFORM_EXPORT WebString text() const;
     54     BLINK_PLATFORM_EXPORT WebString lang() const;
     55     BLINK_PLATFORM_EXPORT WebString voice() const;
     56 
     57     // As defined in: https://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html
     58     BLINK_PLATFORM_EXPORT float volume() const; // 0...1, 1 is default
     59     BLINK_PLATFORM_EXPORT float rate() const; // 0.1...10, 1 is default
     60     BLINK_PLATFORM_EXPORT float pitch() const; // 0...2, 1 is default
     61 
     62     BLINK_PLATFORM_EXPORT double startTime() const; // In seconds.
     63 
     64 #if INSIDE_BLINK
     65     BLINK_PLATFORM_EXPORT WebSpeechSynthesisUtterance(const PassRefPtr<WebCore::PlatformSpeechSynthesisUtterance>&);
     66     BLINK_PLATFORM_EXPORT WebSpeechSynthesisUtterance& operator=(WebCore::PlatformSpeechSynthesisUtterance*);
     67     BLINK_PLATFORM_EXPORT operator PassRefPtr<WebCore::PlatformSpeechSynthesisUtterance>() const;
     68     BLINK_PLATFORM_EXPORT operator WebCore::PlatformSpeechSynthesisUtterance*() const;
     69 #endif
     70 
     71 private:
     72     WebPrivatePtr<WebCore::PlatformSpeechSynthesisUtterance> m_private;
     73 };
     74 
     75 } // namespace blink
     76 
     77 #endif // WebSpeechSynthesisUtterance_h
     78