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.

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

Prerequisites

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

Parameters

name	type	data type	description
placeId	required	string	Stream place ID

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