# bb_camera v0.1.1 - Table of Contents

> Camera support for Beam Bots: the `BB.Camera` behaviour, a bounded shared
capture interface, and Membrane interoperability.

## Pages

- [README](readme.md)

- Tutorials
  - [Writing a camera driver](01-writing-a-camera-driver.md)

## Modules

- [BB.Camera](BB.Camera.md): Behaviour and API for cameras in the BB framework.
- [BB.Camera.Discovery](BB.Camera.Discovery.md): Finds the cameras a robot declares.
- [BB.Camera.Format](BB.Camera.Format.md): Which media formats `bb_camera` will carry, and why it refuses the rest.
- [BB.Camera.Frame](BB.Camera.Frame.md): One independently decodable frame of media.
- [BB.Camera.Hub](BB.Camera.Hub.md): The one capture a camera has, shared by everyone watching it.
- [BB.Camera.Info](BB.Camera.Info.md): What `BB.Camera.discover/1` reports about one camera.
- [BB.Camera.Media](BB.Camera.Media.md): Reading frames from a camera with a loop of your own.
- [BB.Camera.Media.Session](BB.Camera.Media.Session.md): A `BB.Camera.Media` consumer's handle on a camera.
- [BB.Camera.Membrane.Source](BB.Camera.Membrane.Source.md): A `Membrane.Source` that reads from a BB camera.
- [BB.Camera.StreamInfo](BB.Camera.StreamInfo.md): What a camera produces: format and geometry.
- [BB.Camera.Subscription](BB.Camera.Subscription.md): A consumer's handle on a camera's capture.
- [BB.Camera.Synthetic](BB.Camera.Synthetic.md): A camera with no camera behind it.
- [BB.Camera.TestBots.FailingCamera](BB.Camera.TestBots.FailingCamera.md): A camera whose capture never starts.
- [BB.Camera.TestBots.FreeRunningCamera](BB.Camera.TestBots.FreeRunningCamera.md): A camera that clocks itself, for the Membrane pipeline test.
- [BB.Camera.TestBots.GatedCamera](BB.Camera.TestBots.GatedCamera.md): A camera whose every answer to the hub is a test's decision.
- [BB.Camera.TestBots.GimbalCamera](BB.Camera.TestBots.GimbalCamera.md): A camera on a joint that moves.
- [BB.Camera.TestBots.MixedTopology](BB.Camera.TestBots.MixedTopology.md): Cameras at every attachment point, plus a sensor that isn't one.
- [BB.Camera.TestBots.NotACamera](BB.Camera.TestBots.NotACamera.md): An ordinary sensor, to prove discovery discriminates.
- [BB.Camera.TestBots.SingleCamera](BB.Camera.TestBots.SingleCamera.md): One link-attached camera, driven frame by frame.
- [BB.Camera.TestDriver](BB.Camera.TestDriver.md): A camera driver that does nothing until a test tells it to.
- [BB.Message.Camera.BeginCapture](BB.Message.Camera.BeginCapture.md): A camera has started capturing.
- [BB.Message.Camera.CaptureState](BB.Message.Camera.CaptureState.md): How a running capture is actually going, published periodically.
- [BB.Message.Camera.EndCapture](BB.Message.Camera.EndCapture.md): A camera has stopped capturing.

- Exceptions
  - [BB.Error.Hardware.Camera.CaptureFailed](BB.Error.Hardware.Camera.CaptureFailed.md): The driver couldn't start, or couldn't continue, capturing.
  - [BB.Error.Invalid.Camera.StaleFrame](BB.Error.Invalid.Camera.StaleFrame.md): A driver delivered a frame whose sequence didn't advance.
  - [BB.Error.Invalid.Camera.UnknownCamera](BB.Error.Invalid.Camera.UnknownCamera.md): No camera by that name is declared on the robot.
  - [BB.Error.Invalid.Camera.UnknownStreamInfo](BB.Error.Invalid.Camera.UnknownStreamInfo.md): A driver can't say what it will produce from its declared options alone.
  - [BB.Error.Invalid.Camera.UnsupportedFormat](BB.Error.Invalid.Camera.UnsupportedFormat.md): A media format this package will not carry.
  - [BB.Error.State.Camera.EndOfCapture](BB.Error.State.Camera.EndOfCapture.md): Capture stopped cleanly while a consumer was still reading.
  - [BB.Error.State.Camera.NotCapturing](BB.Error.State.Camera.NotCapturing.md): A frame arrived while the camera wasn't capturing.
  - [BB.Error.State.Camera.NotRunning](BB.Error.State.Camera.NotRunning.md): The camera is declared but its `BB.Camera.Hub` isn't alive.
  - [BB.Error.State.Camera.Timeout](BB.Error.State.Camera.Timeout.md): No new frame arrived within the caller's timeout.

