feat: Add isCurrentlyAudible() to WebContents

[felixrieseberg]

Checklist

This PR adds IsCurrentlyAudible to WebContents, allowing developers to determine whether or not audio is currently playing.

• PR description included and stakeholders cc'd
• npm test passes
• tests are changed or added
• relevant documentation is changed or added
• commit messages or PR title follow semantic commit guidelines

[codebytere]

🚀 looks great to me

[felixrieseberg]

I've added a simple test. Major downside: When you're running the test, you'll hear a beep for about 10 milliseconds. Happy to take it out again if people would rather test in silence 😉

[YurySolovyov]

I wonder if it will register if you play recorded silence.

[felixrieseberg]

It looks like the 32bit AppVeyor build had no test failures, but failed in an unrelated script. I can’t restart it, could someone with rights maybe kick it?

[felixrieseberg]

@YurySolovyov It does actually check whether or not sound is really playing, silent or muted audio doesn't count. As an example, in the test, we need to wait a few ms because the oscillator takes a few ms to actually reach an audible level. Cool, right?

[alexeykuzmin]

What if it will take more than 100ms for the oscillator to become audible?

[felixrieseberg]

It never should. In theory, it should start immediately, but the Web Audio API is still a working draft, so I've added the 100ms to ensure that we'll never have a flaky test, even if you're running the test on the slowest of all machines.

[alexeykuzmin]

Ok, if you say so =)

[alexeykuzmin]

Let's use our event helpers and Chai's expect here:

const chai = require('chai')
const dirtyChai = require('dirty-chai')

const {expect} = chai

chai.use(dirtyChai)

<...>

it('returns whether audio is playing', async () => {
  w.loadURL(`file://${path.join(__dirname, 'fixtures', 'api', 'is-currently-audible.html')}`)
  w.show()
  await emittedOnce(w.webContents, 'did-finish-load')
 
  expect(w.webContents.isCurrentlyAudible()).to.be.false()

  w.webContents.send('play')
  await emittedOnce(ipcMain, 'playing')

  expect(w.webContents.isCurrentlyAudible()).to.be.true()
})

[felixrieseberg]

@alexeykuzmin feedback implemented!

[zeke]

Is there precedent for the name IsCurrentlyAudible? Wondering if something like IsPlayingAudio might make more sense.

Also wow I used to love Weezer. Are they still a band?

[alexeykuzmin]

@felixrieseberg

ReferenceError: expect is not defined

Please import all dependencies =)

const chai = require('chai')
const dirtyChai = require('dirty-chai')

const {expect} = chai

chai.use(dirtyChai)

[alexeykuzmin]

@zeke
I guess such a name is because of this

It does actually check whether or not sound is really playing, silent or muted audio doesn't count.

[felixrieseberg]

@zeke That's what Chrome calls it, so I thought it'd be best if we just stick with existing names. I agree that the name ain't great, but going with the same Google has makes it easier for people to browse Google / StackOverflow for edge cases.

[felixrieseberg]

All the failing tests seem to fail on unrelated issues.