Code Monkey home page Code Monkey logo

cordova-plugin-media's Introduction

cordova-plugin-media

Variant of cordova-plugin-media with audio focus management.

Installation

cordova plugin add https://github.com/FmeuMan/cordova-plugin-media

Supported Platforms with audio focus

  • Android
  • iOS

Media.requestFocus

Request audio focus.

Media.requestFocus(options, successCallback);

Parameters

  • successCallback - function(boolean) : called when focus request is granted or refused. The boolean parameter will be set to true of false if focus is granted or not.
  • options - {focusMode: string} :
    • focusMode = 'gain': give full focus to the application, muting other apps (default mode on ios)
    • focusMode = 'mix' : play the sounds while other apps can play sounds too (default mode on android)
    • focusMode = 'duck' : lower volume of other apps

Media.releaseFocus

Release audio focus if any

Media.releaseFocus();

NOTE : Other app may not resume playing sounds depending on how their audio focus management if implemented. This is specialy true for full focus ('gain' focusMode).

media.play

Starts or resumes playing an audio file.

media.play(options);

Parameters

  • options - {focusMode: string, autoReleaseFocus: boolean} :
    • focusMode : same as Media.requestFocus
    • autoReleaseFocus : automaticaly release focus after media play

iOS Quirks

Focus is released on media.release()

cordova-plugin-media's People

Contributors

stevengill avatar agrieve avatar purplecabbage avatar ldeluca avatar clelland avatar bennmapes avatar hermwong avatar cmarcelk avatar shazron avatar timkim avatar alsorokin avatar infil00p avatar sgrebnov avatar cfjedimaster avatar martincgg avatar fmeuman avatar hardeep avatar dblotsky avatar uareurapid avatar mariabukharina avatar javierbb31 avatar jarivas avatar eworx avatar siovene avatar nikhilkh avatar hansmi avatar zaspire avatar mwoghiren avatar jsoref avatar jpchase avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.