Commit 98c51f11 authored by Dom DiCicco's avatar Dom DiCicco Committed by Matt Apperson
Browse files

issue 310 - Added a new property, ignoreSilentSwitch. (#403) 

* issue 310 - Added a new property, ignoreSilentSwitch. When true, audio will play even when the silent switch on an iOS device is set to silent. When false, the audio will toggle with the silent switch. Sets the AVAudioSession to either playback or ambient.

* Added ignoreSilentSwitch usage to example app and to readme

* Changed ignoreSilentSwitch to accept two string values, ignore and obey.
This accounts for the case where the user does not want to modify the audio session from a particular video instance. The user would not use the ignoreSilentSwitch property at all in that case.
Also, the audio session will only be updated when the video is unpaused, instead of whenever the video component has updated props. This allows for multiple videos to be on the screen, with the most recent video unpaused (aka played) being the video that has control over the audio session.
parent c45f5f5b

README.md

+2 −0
Changes for README.md: 2 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ If you would like to allow other apps to play music over your video component, a 
  ...

}

```

Note: you can also use the `ignoreSilentSwitch` prop, shown below.



#### Android
@@ -138,6 +139,7 @@ using System.Collections.Generic; 
       repeat={true}                           // Repeat forever.

       playInBackground={false}                // Audio continues to play when app entering background.

       playWhenInactive={false}                // [iOS] Video continues to play when control or notification center are shown.

       ignoreSilentSwitch={"ignore"}           // [iOS] ignore | obey - When 'ignore', audio will still play with the iOS hard silent switch set to silent. When 'obey', audio will toggle with the switch. When not specified, will inherit audio settings as usual.

       progressUpdateInterval={250.0}          // [iOS] Interval to fire onProgress (default to ~250ms)

       onLoadStart={this.loadStart}            // Callback when video starts to load

       onLoad={this.setDuration}               // Callback when video loads

Video.js

+1 −0
Changes for Video.js: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -278,6 +278,7 @@ Video.propTypes = { 
  rate: PropTypes.number,

  playInBackground: PropTypes.bool,

  playWhenInactive: PropTypes.bool,

  ignoreSilentSwitch: PropTypes.oneOf(['ignore', 'obey']),

  disableFocus: PropTypes.bool,

  controls: PropTypes.bool,

  currentTime: PropTypes.number,

example/index.ios.js

+40 −0
Changes for example/index.ios.js: 40 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -6,6 +6,7 @@ import React, { 
import {

  AlertIOS,

  AppRegistry,

  Platform,

  StyleSheet,

  Text,

  TouchableOpacity,
@@ -31,6 +32,7 @@ class VideoPlayer extends Component { 
    controls: false,

    paused: true,

    skin: 'custom',

    ignoreSilentSwitch: null,

    isBuffering: false,

  };
@@ -106,6 +108,18 @@ class VideoPlayer extends Component { 
    )

  }



  renderIgnoreSilentSwitchControl(ignoreSilentSwitch) {

    const isSelected = (this.state.ignoreSilentSwitch == ignoreSilentSwitch);



    return (

      <TouchableOpacity onPress={() => { this.setState({ignoreSilentSwitch: ignoreSilentSwitch}) }}>

        <Text style={[styles.controlOption, {fontWeight: isSelected ? "bold" : "normal"}]}>

          {ignoreSilentSwitch}

        </Text>

      </TouchableOpacity>

    )

  }



  renderCustomSkin() {

    const flexCompleted = this.getCurrentTimePercentage() * 100;

    const flexRemaining = (1 - this.getCurrentTimePercentage()) * 100;
@@ -120,6 +134,7 @@ class VideoPlayer extends Component { 
            paused={this.state.paused}

            volume={this.state.volume}

            muted={this.state.muted}

            ignoreSilentSwitch={this.state.ignoreSilentSwitch}

            resizeMode={this.state.resizeMode}

            onLoad={this.onLoad}

            onBuffer={this.onBuffer}
@@ -156,6 +171,15 @@ class VideoPlayer extends Component { 
              {this.renderResizeModeControl('stretch')}

            </View>

          </View>

          <View style={styles.generalControls}>

            {

              (Platform.OS === 'ios') ?

                <View style={styles.ignoreSilentSwitchControl}>

                  {this.renderIgnoreSilentSwitchControl('ignore')}

                  {this.renderIgnoreSilentSwitchControl('obey')}

                </View> : null

            }

          </View>



          <View style={styles.trackingControls}>

            <View style={styles.progress}>
@@ -180,6 +204,7 @@ class VideoPlayer extends Component { 
            paused={this.state.paused}

            volume={this.state.volume}

            muted={this.state.muted}

            ignoreSilentSwitch={this.state.ignoreSilentSwitch}

            resizeMode={this.state.resizeMode}

            onLoad={this.onLoad}

            onBuffer={this.onBuffer}
@@ -216,6 +241,15 @@ class VideoPlayer extends Component { 
              {this.renderResizeModeControl('stretch')}

            </View>

          </View>

          <View style={styles.generalControls}>

            {

              (Platform.OS === 'ios') ?

                <View style={styles.ignoreSilentSwitchControl}>

                  {this.renderIgnoreSilentSwitchControl('ignore')}

                  {this.renderIgnoreSilentSwitchControl('obey')}

                </View> : null

            }

          </View>

        </View>



      </View>
@@ -290,6 +324,12 @@ const styles = StyleSheet.create({ 
    alignItems: 'center',

    justifyContent: 'center'

  },

  ignoreSilentSwitchControl: {

    flex: 1,

    flexDirection: 'row',

    alignItems: 'center',

    justifyContent: 'center'

  },

  controlOption: {

    alignSelf: 'center',

    fontSize: 11,

ios/RCTVideo.m

+13 −0
Changes for ios/RCTVideo.m: 13 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -43,6 +43,7 @@ static NSString *const timedMetadata = @"timedMetadata"; 
  BOOL _playbackStalled;

  BOOL _playInBackground;

  BOOL _playWhenInactive;

  NSString * _ignoreSilentSwitch;

  NSString * _resizeMode;

  BOOL _fullscreenPlayerPresented;

  UIViewController * _presentingViewController;
@@ -66,6 +67,7 @@ static NSString *const timedMetadata = @"timedMetadata"; 
    _playerBufferEmpty = YES;

    _playInBackground = false;

    _playWhenInactive = false;

    _ignoreSilentSwitch = @"inherit"; // inherit, ignore, obey



    [[NSNotificationCenter defaultCenter] addObserver:self

                                             selector:@selector(applicationWillResignActive:)
@@ -497,12 +499,23 @@ static NSString *const timedMetadata = @"timedMetadata"; 
  _playWhenInactive = playWhenInactive;

}



- (void)setIgnoreSilentSwitch:(NSString *)ignoreSilentSwitch

{

  _ignoreSilentSwitch = ignoreSilentSwitch;

  [self applyModifiers];

}



- (void)setPaused:(BOOL)paused

{

  if (paused) {

    [_player pause];

    [_player setRate:0.0];

  } else {

    if([_ignoreSilentSwitch isEqualToString:@"ignore"]) {

      [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryPlayback error:nil];

    } else if([_ignoreSilentSwitch isEqualToString:@"obey"]) {

      [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryAmbient error:nil];

    }

    [_player play];

    [_player setRate:_rate];

  }

ios/RCTVideoManager.m

+1 −0
Changes for ios/RCTVideoManager.m: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -28,6 +28,7 @@ RCT_EXPORT_VIEW_PROPERTY(controls, BOOL); 
RCT_EXPORT_VIEW_PROPERTY(volume, float);

RCT_EXPORT_VIEW_PROPERTY(playInBackground, BOOL);

RCT_EXPORT_VIEW_PROPERTY(playWhenInactive, BOOL);

RCT_EXPORT_VIEW_PROPERTY(ignoreSilentSwitch, NSString);

RCT_EXPORT_VIEW_PROPERTY(rate, float);

RCT_EXPORT_VIEW_PROPERTY(seek, float);

RCT_EXPORT_VIEW_PROPERTY(currentTime, float);