Stream

---

List streams

Get a list of streams.

const response = await geocore.Stream.find({
  isLive: boolean,
  placeName: string,
  userId: string,
  startRange: {
    start: "2025-01-01",
    end: "2025-01-01",
  }
  endRange: {
    start: "2025-01-01",
    end: "2025-01-01",
  }
  page: 1,
  limit: 10,
});

Prerequisites

Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.

Parameters

name	type	data type	description
isLive	optional	boolean	Stream is currently live
placeName	optional	string	Search by stream place name
userId	optional	string	Search by user started the stream
startRange[start]	optional	date	Search by startTime timestamp
startRange[end]	optional	date	Search by startTime timestamp
endRange[start]	optional	date	Search by endTime timestamp
endRange[end]	optional	date	Search by endTime timestamp
page	optional	number	Page ordinal number
limit	optional	number	Number of records per page

Get stream token

Get stream token.

const response = await geocore.Stream.getToken({
  hostId: "hostId",
});

Prerequisites

Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.

Parameters

name	type	data type	description
hostId	required	string	Host user ID

Create stream

Create a stream with place information.

const formData = new FormData();
formData.append('name', name);
formData.append('description', description);
formData.append('tags[]', tagIds);
formData.append('geometry[type]', 'Point');
formData.append('geometry[overlay][position][lng]', '12');
formData.append('geometry[overlay][position][lat]', '34');

const response = await geocore.Stream.create(formData);

Prerequisites

Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.

Parameters

name	type	data type	description
name	required	string	Place name
description	required	string	Place description
tags	required	string	Place tags
geometry[type]	required	string	Location geometry type, can be marker, circle, rectangel or polygon
geometry[overlay][position][lng]	required	string	Longitude of place in string, required when geometry type is marker
geometry[overlay][position][lat]	required	string	Latitude of place in string, required when geometry type is marker
geometry[overlay][center][lng]	required	string	Longitude of circle place in string, required when geometry type is circle
geometry[overlay][center][lat]	required	string	Latitude of circle place in string, required when geometry type is circle
geometry[overlay][radius]	required	string	Radius of circle place in string, required when geometry type is circle
geometry[overlay][bounds][north]	required	string	North latitude of rectangle place in string, required when geometry type is rectangle
geometry[overlay][bounds][south]	required	string	South latitude of rectangle place in string, required when geometry type is rectangle
geometry[overlay][bounds][east]	required	string	East longitude of rectangle place in string, required when geometry type is rectangle
geometry[overlay][bounds][west]	required	string	West longitude of rectangle place in string, required when geometry type is rectangle
geometry[overlay][paths][idx][lng]	required	string	Longitude of the vertices in string, required when geometry type is polygon
geometry[overlay][paths][idx][lat]	required	string	Latitude of the vertices in string, required when geometry type is polygon

Start recording

Start stream recording.

const response = await geocore.Stream.startRecording({
  streamId: "string",
});

Prerequisites

Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.

Parameters

name	type	data type	description
streamId	required	string	Stream ID

Stop recording

Stop stream recording.

const response = await geocore.Stream.stopRecording({
  streamId: "string",
});

Prerequisites

Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.

Parameters

name	type	data type	description
streamId	required	string	Stream ID

Update API key

Update an API key.

const response = await geocore.ApiKey.update(
  streamId,
  {
    isLive: boolean,
  }
);

Prerequisites

Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.

Parameters

name	type	data type	description
streamId	required	string	Stream ID
isLive	optional	string	Stream is currently live or not