Bird Services

When a Bird camera identifies what it saw, the event carries event.species: a tree of Species values, each with an id, name, type (compare against SpeciesType.Parent / Child with SpeciesType.fromValue), a probability, and children for finer identifications. Pass Species.id as the birdId below to expand a node into its details.

getBird returns a BirdInfo: id, name, articleLink, extract, images (each with tags, url, resolution) and call (source, url).

Pre-requisite: The user has to be signed in to perform the following operations.

Get the bird details

To get the birds, The following method can be used:

• spaceId (required): The space ID of the device.
• birdId (required): The bird ID.

InstaVision.birdService.getBird(
  spaceId = "spaceId",
  birdId = "birdId",
  onSuccess = { bird ->
    // BirdInfo: id, name, articleLink, extract, images, call
  },
  onError = { error ->
    // The error object contains the error code and message
  }
)