866900 - [Camera] [Docs] API docs need to be updated

Status: RESOLVED INVALID

(Developer Documentation Graveyard :: API: Device API, defect)

Description

[[e-mail] [:onecyrenus]]

The docs on startRecording are not a working example, need to be refreshed with a working code sample.

Comment 1

[[e-mail] [:onecyrenus]]

function setStream(stream) {
    view = document.getElementById('viewfinder');
    view.mozSrcObject = stream;
    view.play();
    Camera.startRecording(config,etc..etc)
}


Camera.getPreviewStreamVideoMode(size, setStream());

Something like the following needs to be done first, you need to getPreviewStreamVideoMode before you can startRecording.

Comment 2

[Jeremie Patonnier :Jeremie]

Mike, as you perform the tech review for the doc, can you confirm this. 
Reading the Gaia and Gecko code doesn't make this obvious to me.
To my understanding, the previewStream is necessary to display the current video stream at the same time as the recording, but I was not aware that the recording *required* that the previewStream has been initialized.

Is it the same for the CameraControl.takePicture method? Is it required to call CameraControl.getPreviewStream before any call to CameraControl.takePicture?

Comment 3

[Mike Habicher [:mikeh] (high bugzilla latency)]

This bug has become quite aged, as have the CameraControl docs. They have grown increasingly stale as the API has evolved over the last year: for example, just looking at comment 2, getPreviewStream() doesn't even exist as a method anymore.

Jeremie, are you still the person to talk to about updating the docs?

Comment 4

[Jean-Yves Perrier [:teoli]]

Mike, have you set the "dev-doc-needed" flag on bugs that changed the API? That's the standard process.

Comment 5

[Jeremie Patonnier :Jeremie]

(In reply to Mike Habicher [:mikeh] from comment #3)
> Jeremie, are you still the person to talk to about updating the docs?

Not anymore, Sheppy takes it back :)

Comment 6

[Florian Scholz (Open Web Docs)]

Camera docs have been archived and won't be updated.